plugin

package

v4.1.2 Latest Latest Go to latest Published: Mar 5, 2024 License: BSD-3-Clause Imports: 20 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/sylabs/singularity

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Create(path, name string) error
func Disable(name string) error
func Enable(name string) error
func Inspect(name string) (pluginapi.Manifest, error)
func Install(sifPath string) error
func LoadCallbacks(cb pluginapi.Callback) ([]pluginapi.Callback, error)
func LoadObject(path string) (*pluginapi.Plugin, error)
func PrepareGoModules(pluginDir string, disableMinorCheck bool) ([]byte, error)
func Uninstall(name string) error
type GoMod
- func GetModules(dir string) (*GoMod, error)
- func (g GoMod) GetExclude(path string) *Module
- func (g GoMod) GetReplace(path string) *Replace
- func (g GoMod) GetRequire(path string) *Require
type Meta
- func List() ([]*Meta, error)
type Module
- func (m Module) String() string
type Replace
- func (r Replace) String() string
type Require
- func (r Require) String() string

Constants ¶

View Source

const SingularitySource = "singularity_source"

SingularitySource represents the symlink name which will point to the Singularity source directory.

Variables ¶

This section is empty.

Functions ¶

func Create ¶

func Create(path, name string) error

Create creates a skeleton plugin directory structure to start development of a new plugin.

func Disable ¶

func Disable(name string) error

Disable disables the plugin named "name" found under rootDir.

func Enable ¶

func Enable(name string) error

Enable enables the plugin named "name" found under rootDir.

func Inspect ¶

func Inspect(name string) (pluginapi.Manifest, error)

Inspect obtains information about the plugin "name".

"name" can be either the name of plugin installed under rootDir or the name of an image file corresponding to a plugin.

func Install ¶

func Install(sifPath string) error

Install installs a plugin from a SIF image under rootDir. It will:

Check that the SIF is a valid plugin
Use name from Manifest and calculate the installation path
Copy the SIF into the plugin path
Extract the binary object into the path
Generate a default config file in the path
Write the Meta struct onto disk in dirRoot

func LoadCallbacks ¶

func LoadCallbacks(cb pluginapi.Callback) ([]pluginapi.Callback, error)

LoadCallbacks loads plugins registered for the hook instance passed in parameter.

func LoadObject ¶

func LoadObject(path string) (*pluginapi.Plugin, error)

LoadObject loads a plugin object in memory and returns the Plugin object set within the plugin.

func PrepareGoModules ¶

func PrepareGoModules(pluginDir string, disableMinorCheck bool) ([]byte, error)

PrepareGoModules returns a byte array containing a generated go.mod matching Singularity modules in use in order to compile/load the plugin with same version of dependencies.

func Uninstall ¶

func Uninstall(name string) error

Uninstall removes the plugin matching "name" from the singularity plugin installation directory.

Types ¶

func GetModules ¶

func GetModules(dir string) (*GoMod, error)

GetModules parses the go.mod file found in directory and returns a GoMod instance.

func (GoMod) GetExclude ¶

func (g GoMod) GetExclude(path string) *Module

GetExclude returns the exclude record for the provided module path.

func (GoMod) GetReplace ¶

func (g GoMod) GetReplace(path string) *Replace

GetReplace returns the replace record for the provided module path.

func (GoMod) GetRequire ¶

func (g GoMod) GetRequire(path string) *Require

GetRequire returns the require record for the provided module path.

type Meta ¶

type Meta struct {
	// Name is the name of the plugin.
	Name string
	// Enabled reports whether or not the plugin should be loaded.
	Enabled bool
	// Callbacks contains callbacks name registered by the plugin.
	Callbacks []string
}

Meta is an internal representation of a plugin binary and all of its artifacts. This represents the on-disk location of the SIF, shared library, config file, etc... This struct is written as JSON into the rootDir directory.

func List ¶

func List() ([]*Meta, error)

List returns all the singularity plugins installed in rootDir in the form of a list of Meta information.

type Module ¶

type Module struct {
	Path    string
	Version string
}

Module describes a Go module with its corresponding path and version.

func (Module) String ¶

func (m Module) String() string

String returns the string representation of a module.

type Replace ¶

type Replace struct {
	Old Module
	New Module
}

Replace describes a replace directive in go.mod files.

func (Replace) String ¶

func (r Replace) String() string

String returns the string representation of a replace line.

type Require ¶

type Require struct {
	Path     string
	Version  string
	Indirect bool
}

Require describes a require directive in go.mod files.

func (Require) String ¶

func (r Require) String() string

String returns the string representation of a require line.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
callback

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL