maven

Documentation

Index

• func Evaluate(options *EvaluateOptions, expression string, command mavenExecRunner) (string, error)
• func Execute(options *ExecuteOptions, command mavenExecRunner) (string, error)
• func GetSettingsFile(settingsFileType SettingsFileType, src string, fileUtils piperutils.FileUtils, ...) error
• func GetTestModulesExcludes() []string
• func InstallFile(file, pomFile, m2Path string, command mavenExecRunner) error
• func InstallMavenArtifacts(command mavenExecRunner, options EvaluateOptions) error
• type EvaluateOptions
• type ExecuteOptions
• type SettingsFileType

Functions

func Evaluate

func Evaluate(options *EvaluateOptions, expression string, command mavenExecRunner) (string, error)

Evaluate constructs ExecuteOptions for using the maven-help-plugin's 'evaluate' goal to evaluate a given expression from a pom file. This allows to retrieve the value of - for example - 'project.version' from a pom file exactly as Maven itself evaluates it.

func Execute

func Execute(options *ExecuteOptions, command mavenExecRunner) (string, error)

Execute constructs a mvn command line from the given options, and uses the provided mavenExecRunner to execute it.

func GetSettingsFile

func GetSettingsFile(settingsFileType SettingsFileType, src string, fileUtils piperutils.FileUtils, httpClient piperhttp.Downloader) error

GetSettingsFile ...

func GetTestModulesExcludes

func GetTestModulesExcludes() []string

func InstallFile

func InstallFile(file, pomFile, m2Path string, command mavenExecRunner) error

InstallFile installs a maven artifact and its pom into the local maven repository. If "file" is empty, only the pom is installed. "pomFile" must not be empty.

func InstallMavenArtifacts

func InstallMavenArtifacts(command mavenExecRunner, options EvaluateOptions) error

InstallMavenArtifacts finds maven modules (identified by pom.xml files) and installs the artifacts into the local maven repository.

Types

type EvaluateOptions

type EvaluateOptions struct {
	PomPath             string   `json:"pomPath,omitempty"`
	ProjectSettingsFile string   `json:"projectSettingsFile,omitempty"`
	GlobalSettingsFile  string   `json:"globalSettingsFile,omitempty"`
	M2Path              string   `json:"m2Path,omitempty"`
	Defines             []string `json:"defines,omitempty"`
}

EvaluateOptions are used by Evaluate() to construct the Maven command line. In contrast to ExecuteOptions, fewer settings are required for Evaluate and thus a separate type is needed.

type ExecuteOptions

type ExecuteOptions struct {
	PomPath                     string   `json:"pomPath,omitempty"`
	ProjectSettingsFile         string   `json:"projectSettingsFile,omitempty"`
	GlobalSettingsFile          string   `json:"globalSettingsFile,omitempty"`
	M2Path                      string   `json:"m2Path,omitempty"`
	Goals                       []string `json:"goals,omitempty"`
	Defines                     []string `json:"defines,omitempty"`
	Flags                       []string `json:"flags,omitempty"`
	LogSuccessfulMavenTransfers bool     `json:"logSuccessfulMavenTransfers,omitempty"`
	ReturnStdout                bool     `json:"returnStdout,omitempty"`
}

ExecuteOptions are used by Execute() to construct the Maven command line.

type SettingsFileType

type SettingsFileType int

SettingsFileType ...

const (
	// GlobalSettingsFile ...
	GlobalSettingsFile SettingsFileType = iota
	// ProjectSettingsFile ...
	ProjectSettingsFile
)