@hashgraph/solo
Version:
An opinionated CLI tool to deploy and manage private Hedera Networks.
219 lines • 11 kB
JavaScript
// SPDX-License-Identifier: Apache-2.0
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
return c > 3 && r && Object.defineProperty(target, key, r), r;
};
var __metadata = (this && this.__metadata) || function (k, v) {
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
};
var __param = (this && this.__param) || function (paramIndex, decorator) {
return function (target, key) { decorator(target, key, paramIndex); }
};
var PodmanDependencyManager_1;
import * as constants from '../constants.js';
import * as version from '../../../version.js';
import { inject, injectable } from 'tsyringe-neo';
import { patchInject } from '../dependency-injection/container-helper.js';
import { InjectTokens } from '../dependency-injection/inject-tokens.js';
import { BaseDependencyManager } from './base-dependency-manager.js';
import { PackageDownloader } from '../package-downloader.js';
import util from 'node:util';
import { SoloError } from '../errors/solo-error.js';
import fs from 'node:fs';
import { Zippy } from '../zippy.js';
import { PodmanMode } from '../../types/index.js';
import { PathEx } from '../../business/utils/path-ex.js';
import { OperatingSystem } from '../../business/utils/operating-system.js';
const PODMAN_RELEASES_LIST_URL = 'https://api.github.com/repos/containers/podman/releases';
let PodmanDependencyManager = PodmanDependencyManager_1 = class PodmanDependencyManager extends BaseDependencyManager {
zippy;
helpersDirectory;
checksum;
releaseBaseUrl;
artifactFileName;
artifactVersion;
constructor(downloader, installationDirectory, osArch, podmanVersion, zippy, helpersDirectory) {
super(patchInject(downloader, InjectTokens.PackageDownloader, PodmanDependencyManager_1.name), patchInject(installationDirectory, InjectTokens.PodmanInstallationDirectory, PodmanDependencyManager_1.name), patchInject(osArch, InjectTokens.OsArch, PodmanDependencyManager_1.name), patchInject(podmanVersion, InjectTokens.PodmanVersion, PodmanDependencyManager_1.name) || version.PODMAN_VERSION, constants.PODMAN, '');
this.zippy = zippy;
this.helpersDirectory = helpersDirectory;
this.zippy = patchInject(this.zippy, InjectTokens.Zippy, PodmanDependencyManager_1.name);
this.helpersDirectory = patchInject(this.helpersDirectory, InjectTokens.PodmanDependenciesInstallationDirectory, PodmanDependencyManager_1.name);
}
/**
* Get the Podman artifact name based on version, OS, and architecture
*/
getArtifactName() {
return util.format(this.artifactFileName, this.getRequiredVersion(), OperatingSystem.getFormattedPlatform(), this.osArch);
}
get mode() {
return OperatingSystem.isLinux() ? PodmanMode.ROOTFUL : PodmanMode.VIRTUAL_MACHINE;
}
async getVersion(executableWithPath) {
// The retry logic is to handle potential transient issues with the command execution
// The command `podman --version` was sometimes observed to return an empty output in the CI environment
const maxAttempts = 3;
for (let attempt = 1; attempt <= maxAttempts; attempt++) {
try {
const output = await this.run(`"${executableWithPath}" --version`);
if (output.length > 0) {
const match = output[0].trim().match(/(\d+\.\d+\.\d+)/);
return match[1];
}
}
catch (error) {
throw new SoloError('Failed to check podman version', error);
}
}
throw new SoloError('Failed to check podman version');
}
/**
* Fetches the latest release information from GitHub API
* @returns Promise with the release base URL, asset name, digest, and version
*/
async fetchReleaseInfo(tagName) {
try {
// Make a GET request to GitHub API using fetch
const response = await fetch(PODMAN_RELEASES_LIST_URL, {
method: 'GET', // Changed from HEAD to GET to retrieve the body
headers: {
'User-Agent': constants.SOLO_USER_AGENT_HEADER,
Accept: 'application/vnd.github.v3+json', // Explicitly request GitHub API v3 format
},
});
if (!response.ok) {
throw new SoloError(`GitHub API request failed with status ${response.status}`);
}
// Parse the JSON response
const releases = await response.json();
if (!releases || releases.length === 0) {
throw new SoloError('No releases found');
}
// Get the latest release
const release = releases.find(release => release.tag_name === tagName);
const version = release.tag_name.replace(/^v/, ''); // Remove 'v' prefix if present
// Normalize platform/arch for asset matching
const arch = this.getArch();
// Construct asset pattern based on platform
let assetPattern;
if (OperatingSystem.isWin32()) {
// Windows
assetPattern = new RegExp(String.raw `podman-remote-release-windows_${arch}\.zip$`);
}
else if (OperatingSystem.isDarwin()) {
// macOS
assetPattern = new RegExp(String.raw `podman-remote-release-darwin_${arch}\.zip$`);
}
else {
// Linux
assetPattern = new RegExp(String.raw `podman-remote-static-linux_${arch}\.tar\.gz$`);
}
// Find the matching asset
const matchingAsset = release.assets.find(asset => assetPattern.test(asset.browser_download_url));
if (!matchingAsset) {
throw new SoloError(`No matching asset found for ${OperatingSystem.getPlatform()}-${arch}`);
}
// Get the digest from the shasums file
const checksum = matchingAsset.digest
? matchingAsset.digest.replace('sha256:', '')
: '0000000000000000000000000000000000000000000000000000000000000000';
// Construct the release base URL (removing the filename from the download URL)
const downloadUrl = matchingAsset.browser_download_url.slice(0, Math.max(0, matchingAsset.browser_download_url.lastIndexOf('/')));
return {
downloadUrl,
assetName: matchingAsset.name,
checksum,
version,
};
}
catch (error) {
if (error instanceof SoloError) {
throw error;
}
throw new SoloError('Failed to parse GitHub API response', error);
}
}
// Podman should only be installed if Docker is not already present on the client system
async shouldInstall() {
// Check if Podman is explicitly requested via environment variable
if (process.env.FORCE_PODMAN === 'true') {
return true;
}
// Determine if Docker is already installed
try {
await this.run(`"${constants.DOCKER}" --version`);
return false;
}
catch {
return true;
}
}
async preInstall() {
const releaseInfo = await this.fetchReleaseInfo(version.PODMAN_VERSION);
this.checksum = releaseInfo.checksum;
this.releaseBaseUrl = releaseInfo.downloadUrl;
this.artifactFileName = releaseInfo.assetName;
this.artifactVersion = releaseInfo.version;
}
getDownloadURL() {
return `${this.releaseBaseUrl}/${this.artifactFileName}`;
}
/**
* Handle any post-download processing before copying to destination
* Child classes can override this for custom extraction or processing
*/
async processDownloadedPackage(packageFilePath, temporaryDirectory) {
// Extract the archive based on file extension
if (packageFilePath.endsWith('.zip')) {
this.zippy.unzip(packageFilePath, temporaryDirectory);
}
else {
this.zippy.untar(packageFilePath, temporaryDirectory);
}
let binDirectory;
if (OperatingSystem.isLinux()) {
binDirectory = PathEx.join(temporaryDirectory, 'bin');
const arch = this.getArch();
fs.renameSync(PathEx.join(binDirectory, `podman-remote-static-linux_${arch}`), PathEx.join(binDirectory, constants.PODMAN));
}
else {
// Find the Podman executable inside the extracted directory
binDirectory = PathEx.join(temporaryDirectory, `${constants.PODMAN}-${this.artifactVersion}`, 'usr', 'bin');
}
return fs.readdirSync(binDirectory).map((file) => PathEx.join(binDirectory, file));
}
getChecksumURL() {
return this.checksum;
}
/**
* Create a custom containers.conf file for Podman and set the CONTAINERS_CONF env variable
* @private
*/
async setupConfig() {
// Create the containers.conf file from the template
const configDirectory = PathEx.join(constants.SOLO_HOME_DIR, 'config');
if (!fs.existsSync(configDirectory)) {
fs.mkdirSync(configDirectory, { recursive: true });
}
const templatesDirectory = PathEx.join(constants.SOLO_HOME_DIR, 'cache', 'templates');
const templatePath = PathEx.join(templatesDirectory, 'podman', 'containers.conf');
const destinationPath = PathEx.join(configDirectory, 'containers.conf');
let configContent = fs.readFileSync(templatePath, 'utf8');
configContent = configContent.replace('$HELPER_BINARIES_DIR', this.helpersDirectory.replaceAll('\\', '/'));
fs.writeFileSync(destinationPath, configContent, 'utf8');
process.env.CONTAINERS_CONF = destinationPath;
}
};
PodmanDependencyManager = PodmanDependencyManager_1 = __decorate([
injectable(),
__param(0, inject(InjectTokens.PackageDownloader)),
__param(1, inject(InjectTokens.PodmanInstallationDirectory)),
__param(2, inject(InjectTokens.OsArch)),
__param(3, inject(InjectTokens.PodmanVersion)),
__param(4, inject(InjectTokens.Zippy)),
__param(5, inject(InjectTokens.PodmanDependenciesInstallationDirectory)),
__metadata("design:paramtypes", [PackageDownloader, String, String, String, Zippy, String])
], PodmanDependencyManager);
export { PodmanDependencyManager };
//# sourceMappingURL=podman-dependency-manager.js.map