Class PodmanDependencyManager

Base class for dependency managers that download and manage CLI tools Common functionality for downloading, checking versions, and managing executables

Hierarchy (View Summary)

BaseDependencyManager
- PodmanDependencyManager

Constructors

constructor

new PodmanDependencyManager(
    downloader: PackageDownloader,
    installationDirectory: string,
    osArch: string,
    podmanVersion: string,
    zippy: Zippy,
    helpersDirectory: string,
): PodmanDependencyManager
Parameters
- downloader: PackageDownloader
- installationDirectory: string
- osArch: string
- podmanVersion: string
- zippy: Zippy
- helpersDirectory: string
Returns PodmanDependencyManager
Overrides BaseDependencyManager.constructor
- Defined in src/core/dependency-managers/podman-dependency-manager.ts:27

Properties

`Protected`artifactFileName

artifactFileName: string

`Protected` `Readonly`artifactName

artifactName: string

`Protected`artifactVersion

artifactVersion: string

`Protected`checksum

checksum: string

`Protected` `Readonly`checksumURL

checksumURL: string

`Protected` `Readonly`downloadBaseUrl

downloadBaseUrl: string

`Protected` `Readonly`downloader

downloader: PackageDownloader

`Protected` `Readonly`downloadURL

downloadURL: string

`Protected` `Readonly`executableName

executableName: string

`Protected`globalExecutablePath

globalExecutablePath: string = ''

`Protected` `Readonly`helpersDirectory

helpersDirectory: string

`Protected` `Readonly`installationDirectory

installationDirectory: string

`Protected`localExecutableWithPath

localExecutableWithPath: string

`Optional`logger

logger?: SoloLogger

`Protected` `Readonly`osArch

osArch: string

`Protected`releaseBaseUrl

releaseBaseUrl: string

`Protected` `Readonly`requiredVersion

requiredVersion: string

Accessors

mode

get mode(): PodmanMode
Returns PodmanMode
- Defined in src/core/dependency-managers/podman-dependency-manager.ts:64

Methods

`Protected`getArch

getArch(): string
Returns string
Inherited from BaseDependencyManager.getArch
- Defined in src/core/dependency-managers/base-dependency-manager.ts:62

`Protected`getArtifactName

getArtifactName(): string
Get the Podman artifact name based on version, OS, and architecture

Returns string
Overrides BaseDependencyManager.getArtifactName
- Defined in src/core/dependency-managers/podman-dependency-manager.ts:55

`Protected`getChecksumURL

getChecksumURL(): string
Get the checksum URL for the executable

Returns string
Overrides BaseDependencyManager.getChecksumURL
- Defined in src/core/dependency-managers/podman-dependency-manager.ts:220

`Protected`getDownloadURL

getDownloadURL(): string
Get the download URL for the executable

Returns string
Overrides BaseDependencyManager.getDownloadURL
- Defined in src/core/dependency-managers/podman-dependency-manager.ts:188

getExecutable

getExecutable(): Promise<string>
Get the executable to run

Returns Promise<string>
Inherited from BaseDependencyManager.getExecutable
- Defined in src/core/dependency-managers/base-dependency-manager.ts:99

getRequiredVersion

getRequiredVersion(): string
Get the tool's required version

Returns string
Inherited from BaseDependencyManager.getRequiredVersion
- Defined in src/core/dependency-managers/base-dependency-manager.ts:277

getVerifyChecksum

getVerifyChecksum(): boolean
Determine if checksum verification should be performed Child classes can override this if needed

Returns boolean
Inherited from BaseDependencyManager.getVerifyChecksum
- Defined in src/core/dependency-managers/base-dependency-manager.ts:210

getVersion

getVersion(executableWithPath: string): Promise<string>
Parameters
- executableWithPath: string
Returns Promise<string>
Overrides BaseDependencyManager.getVersion
- Defined in src/core/dependency-managers/podman-dependency-manager.ts:68

install

install(temporaryDirectory?: string): Promise<boolean>
Install the tool
Parameters
- temporaryDirectory: string = ...
Returns Promise<boolean>
Inherited from BaseDependencyManager.install
- Defined in src/core/dependency-managers/base-dependency-manager.ts:217

installationMeetsRequirements

installationMeetsRequirements(executableWithPath: string): Promise<boolean>
Check if the given installation meets version requirements
Parameters
- executableWithPath: string
Returns Promise<boolean>
Inherited from BaseDependencyManager.installationMeetsRequirements
- Defined in src/core/dependency-managers/base-dependency-manager.ts:126

isInstalledLocally

isInstalledLocally(): boolean
Check if the tool is installed locally

Returns boolean
Inherited from BaseDependencyManager.isInstalledLocally
- Defined in src/core/dependency-managers/base-dependency-manager.ts:180

`Protected`preInstall

preInstall(): Promise<void>
Hook for any pre-installation steps

Returns Promise<void>
Overrides BaseDependencyManager.preInstall
- Defined in src/core/dependency-managers/podman-dependency-manager.ts:180

`Protected`processDownloadedPackage

processDownloadedPackage(
packageFilePath: string,
temporaryDirectory: string,
): Promise<string[]>
Handle any post-download processing before copying to destination Child classes can override this for custom extraction or processing
Parameters
- packageFilePath: string
- temporaryDirectory: string
Returns Promise<string[]>
Overrides BaseDependencyManager.processDownloadedPackage
- Defined in src/core/dependency-managers/podman-dependency-manager.ts:196

run

run(
    cmd: string,
    arguments_?: string[],
    verbose?: boolean,
    detached?: boolean,
    environmentVariablesToAppend?: Record<string, string>,
): Promise<string[]>
Returns a promise that invokes the shell command
Parameters
- cmd: string
- arguments_: string[] = []
- verbose: boolean = false
- detached: boolean = false
- environmentVariablesToAppend: Record<string, string> = {}
Returns Promise<string[]>
Inherited from BaseDependencyManager.run
- Defined in src/core/shell-runner.ts:18

setupConfig

setupConfig(): Promise<void>
Create a custom containers.conf file for Podman and set the CONTAINERS_CONF env variable

Returns Promise<void>
Private
Overrides BaseDependencyManager.setupConfig
- Defined in src/core/dependency-managers/podman-dependency-manager.ts:228

shouldInstall

shouldInstall(): Promise<boolean>
Hook to determine if installation should proceed Child classes can override this for custom logic

Returns Promise<boolean>
Overrides BaseDependencyManager.shouldInstall
- Defined in src/core/dependency-managers/podman-dependency-manager.ts:165

sudoRun

sudoRun(
    sudoRequested: (message: string) => void,
    sudoGranted: (message: string) => void,
    cmd: string,
    arguments_?: string[],
    verbose?: boolean,
    detached?: boolean,
    environmentVariablesToAppend?: Record<string, string>,
): Promise<string[]>
Parameters
- sudoRequested: (message: string) => void
- sudoGranted: (message: string) => void
- cmd: string
- arguments_: string[] = []
- verbose: boolean = false
- detached: boolean = false
- environmentVariablesToAppend: Record<string, string> = {}
Returns Promise<string[]>
Inherited from BaseDependencyManager.sudoRun
- Defined in src/core/shell-runner.ts:106

uninstallLocal

uninstallLocal(): void
Uninstall the local version

Returns void
Inherited from BaseDependencyManager.uninstallLocal
- Defined in src/core/dependency-managers/base-dependency-manager.ts:187

Class PodmanDependencyManager

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PodmanDependencyManager

Properties

ProtectedartifactFileName

Protected ReadonlyartifactName

ProtectedartifactVersion

Protectedchecksum

Protected ReadonlychecksumURL

Protected ReadonlydownloadBaseUrl

Protected Readonlydownloader

Protected ReadonlydownloadURL

Protected ReadonlyexecutableName

ProtectedglobalExecutablePath

Protected ReadonlyhelpersDirectory

Protected ReadonlyinstallationDirectory

ProtectedlocalExecutableWithPath

Optionallogger

Protected ReadonlyosArch

ProtectedreleaseBaseUrl

Protected ReadonlyrequiredVersion

Accessors

mode

Returns PodmanMode

Methods

ProtectedgetArch

Returns string

ProtectedgetArtifactName

Returns string

ProtectedgetChecksumURL

Returns string

ProtectedgetDownloadURL

Returns string

getExecutable

Returns Promise<string>

getRequiredVersion

Returns string

getVerifyChecksum

Returns boolean

getVersion

Parameters

Returns Promise<string>

install

Parameters

Returns Promise<boolean>

installationMeetsRequirements

Parameters

Returns Promise<boolean>

isInstalledLocally

Returns boolean

ProtectedpreInstall

Returns Promise<void>

ProtectedprocessDownloadedPackage

Parameters

Returns Promise<string[]>

run

Parameters

Returns Promise<string[]>

setupConfig

Returns Promise<void>

Private

shouldInstall

Returns Promise<boolean>

sudoRun

Parameters

Returns Promise<string[]>

uninstallLocal

Returns void

Settings

On This Page

`Protected`artifactFileName

`Protected` `Readonly`artifactName

`Protected`artifactVersion

`Protected`checksum

`Protected` `Readonly`checksumURL

`Protected` `Readonly`downloadBaseUrl

`Protected` `Readonly`downloader

`Protected` `Readonly`downloadURL

`Protected` `Readonly`executableName

`Protected`globalExecutablePath

`Protected` `Readonly`helpersDirectory

`Protected` `Readonly`installationDirectory

`Protected`localExecutableWithPath

`Optional`logger

`Protected` `Readonly`osArch

`Protected`releaseBaseUrl

`Protected` `Readonly`requiredVersion

`Protected`getArch

`Protected`getArtifactName

`Protected`getChecksumURL

`Protected`getDownloadURL

`Protected`preInstall

`Protected`processDownloadedPackage