xdeb

Documentation

Index

• Constants
• Variables
• func DownloadFile(path string, baseRequestUrl string, followRedirects bool, compress bool) (string, error)
• func ExecuteCommand(workdir string, args ...string) error
• func FindArchitecture() (string, error)
• func FindXdeb() (string, error)
• func InstallPackage(packageDefinition *XdebPackageDefinition, context *cli.Context) error
• func LogMessage(format string, args ...any)
• func NewHttpClient() *http.Client
• func RepositoryPath() (string, error)
• func SyncRepositories(lists *PackageListsDefinition, providerNames ...string) error
• func TrimPathExtension(path string, count int) string
• type PackageListsDefinition
  • func ParsePackageLists() (*PackageListsDefinition, error)
• type PackageListsProvider
• type XdebPackageDefinition
  • func FindPackage(name string, path string, provider string, distribution string, exact bool) ([]*XdebPackageDefinition, error)
  • func (packageDefinition *XdebPackageDefinition) Configure(rootPath string)
• type XdebPackagePostInstallCommandDefinition
• type XdebPackagePostInstallDefinition
• type XdebProviderDefinition

Constants

const APPLICATION_NAME = "xdeb-install"

const HTTP_REQUEST_HEADERS_TIMEOUT = 10 * time.Second

const LOG_MESSAGE_PREFIX = "[" + APPLICATION_NAME + "]"

const XDEB_INSTALL_REPOSITORIES_TAG = "v1.1.2"

const XDEB_INSTALL_REPOSITORIES_URL = "https://raw.githubusercontent.com/xdeb-org/xdeb-install-repositories"

const XDEB_MASTER_URL = "https://raw.githubusercontent.com/xdeb-org/xdeb/master"

const XDEB_URL = "https://github.com/xdeb-org/xdeb/releases"

Variables

var ARCHITECTURE_MAP = map[string]string{
	"amd64": "x86_64",
	"arm64": "aarch64",
	"386":   "i686",
}

Functions

func DownloadFile

func DownloadFile(path string, baseRequestUrl string, followRedirects bool, compress bool) (string, error)

func ExecuteCommand

func ExecuteCommand(workdir string, args ...string) error

func FindArchitecture

func FindArchitecture() (string, error)

func FindXdeb

func FindXdeb() (string, error)

func InstallPackage

func InstallPackage(packageDefinition *XdebPackageDefinition, context *cli.Context) error

func LogMessage

func LogMessage(format string, args ...any)

func NewHttpClient

func NewHttpClient() *http.Client

func RepositoryPath

func RepositoryPath() (string, error)

func SyncRepositories

func SyncRepositories(lists *PackageListsDefinition, providerNames ...string) error

func TrimPathExtension

func TrimPathExtension(path string, count int) string

Types

type PackageListsDefinition

type PackageListsDefinition struct {
	Path      string                 `yaml:"path,omitempty"`
	Providers []PackageListsProvider `yaml:"providers"`
}

func ParsePackageLists

func ParsePackageLists() (*PackageListsDefinition, error)

type PackageListsProvider

type PackageListsProvider struct {
	Name          string   `yaml:"name"`
	Custom        bool     `yaml:"custom"`
	Url           string   `yaml:"url"`
	Architecture  string   `yaml:"architecture"`
	Components    []string `yaml:"components"`
	Distributions []string `yaml:"dists"`
}

type XdebPackageDefinition

type XdebPackageDefinition struct {
	Name         string                             `yaml:"name"`
	Version      string                             `yaml:"version"`
	Url          string                             `yaml:"url"`
	Sha256       string                             `yaml:"sha256"`
	PostInstall  []XdebPackagePostInstallDefinition `yaml:"post-install,omitempty"`
	Path         string                             `yaml:"path,omitempty"`
	FilePath     string                             `yaml:"filepath,omitempty"`
	Provider     string                             `yaml:"provider,omitempty"`
	Distribution string                             `yaml:"distribution,omitempty"`
	Component    string                             `yaml:"component,omitempty"`
	IsConfigured bool                               `yaml:"is_configured,omitempty"`
}

func FindPackage

func FindPackage(name string, path string, provider string, distribution string, exact bool) ([]*XdebPackageDefinition, error)

func (*XdebPackageDefinition) Configure

func (packageDefinition *XdebPackageDefinition) Configure(rootPath string)

type XdebPackagePostInstallCommandDefinition

type XdebPackagePostInstallCommandDefinition struct {
	Root    bool   `yaml:"root"`
	Command string `yaml:"command"`
}

type XdebPackagePostInstallDefinition

type XdebPackagePostInstallDefinition struct {
	Name     string                                    `yaml:"name"`
	Commands []XdebPackagePostInstallCommandDefinition `yaml:"commands"`
}

type XdebProviderDefinition

type XdebProviderDefinition struct {
	Xdeb []*XdebPackageDefinition `yaml:"xdeb"`
}