Package com.igormaznitsa.mvngolang

Class AbstractGolangMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.igormaznitsa.mvngolang.AbstractGolangMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

Direct Known Subclasses:

AbstractGoDependencyAwareMojo, AbstractGoPackageAwareMojo

public abstract class AbstractGolangMojo
extends org.apache.maven.plugin.AbstractMojo

Field Summary

Fields

Modifier and Type	Field	Description
protected Set<String>	buildFlagsToIgnore	set of flags to be ignored among build and extra build flags, for inside use
static String	ENV_GO111MODULE
static String	GO_MOD_FILE_NAME
static String	GO_SUM_FILE_NAME
static String	GOARTIFACT_PACKAGING
static String	NAME_PATTERN	VERSION, OS, PLATFORM,-OSXVERSION
protected org.apache.maven.settings.Settings	settings
protected List<String>	tempBuildFlags

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor	Description
AbstractGolangMojo()

Method Summary

Modifier and Type	Method	Description
protected static String	adaptExecNameForOS(String execName)
protected void	addTmpBuildFlagIfNotPresented(String... flags)
void	afterExecution(ProxySettings proxySettings, boolean error)
void	beforeExecution(ProxySettings proxySettings)
protected boolean	doesNeedOneMoreAttempt(org.zeroturnaround.exec.ProcessResult result, String consoleOut, String consoleErr)
protected boolean	doesNeedSessionLock()
void	doInit()
protected void	doLogging(int resultCode, boolean error, String outLog, String errLog)
protected boolean	doMainBusiness(ProxySettings proxySettings, int maxAttempts)
void	execute()
protected List<File>	findAllGoModsInFolder(File folder)
protected static File	findExisting(File... files)
File[]	findGoPath(boolean ensureExist)
protected File	findGoRoot(ProxySettings proxySettings)
File	findGoRootBootstrap(boolean ensureExist)
protected String	findMvnProperty(String key, String dflt)
String	getArch()
org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver	getArtifactResolver()
String[]	getBuildFlags()
abstract String[]	getCommandFlags()
int	getConnectionTimeout()
Map<?,?>	getEnv()
String	getErrLogFile()
String	getExec()
String	getExecSubpath()
org.apache.maven.plugin.MojoExecution	getExecution()
protected String[]	getExtraBuildFlags()
String	getGoBin()
String	getGoCache()
abstract String	getGoCommand()
String	getGoPath()
String	getGoRoot()
String	getGoRootBootstrap()
String	getGoVersion()
String[]	getOptionalExtraTailArguments()
String	getOs()
String	getOSXVersion()
String	getOutLogFile()
org.apache.maven.project.MavenProject	getProject()
ProxySettings	getProxy()
List<org.apache.maven.artifact.repository.ArtifactRepository>	getRemoteRepositories()
String	getReportsFolder()
String	getSdkArchiveName()
String	getSdkDownloadUrl()
String	getSdkSite()
org.apache.maven.execution.MavenSession	getSession()
protected String	getSkipMojoPropertySuffix()
File	getSources(boolean ensureExist)
protected String	getSpecialPartOfGoPath()	Internal method which returns special part of GOPATH which can be formed by mojos.
String	getStoreFolder()
boolean	getSupposeSdkArchiveFileName()
abstract String[]	getTailArguments()
String	getTarget386()
String	getTargetArch()
String	getTargetArm()
String	getTargetOS()
protected File	getTempFileFolder()
String	getUseGoTool()
String	getWorkingDir()
protected File	getWorkingDirectoryForExecutor()
protected void	initConsoleBuffers()
boolean	isCheckSdkHash()
boolean	isCommandSupportVerbose()
boolean	isDisableSdkLoad()
boolean	isDisableSslCheck()
boolean	isEnforceGoPathToEnd()
boolean	isEnforcePrintOutput()
boolean	isFilterEnvPath()
boolean	isHideBanner()
boolean	isIgnoreErrorExitCode()
boolean	isKeepSdkArchive()
boolean	isKeepUnarchFolderIfError()
boolean	isModuleMode()
boolean	isMojoMustNotBeExecuted()
boolean	isSkip()
boolean	isSourceFolderRequired()
boolean	isUseEnvVars()
boolean	isUseMavenProxy()
boolean	isVerbose()
protected void	logOptionally(String message)
String	makeExecutableFileSubpath()
protected String	makePathFromExtraGoPathElements()
protected org.zeroturnaround.exec.ProcessExecutor	prepareExecutor(ProxySettings proxySettings)
protected void	printLogs(boolean forcePrint, boolean errorDetected, String outLog, String errLog)
protected void	registerEnvVars(org.zeroturnaround.exec.ProcessExecutor result, File theGoRoot, String theGoBin, String theGoCache, File sourcesFile, File[] goPathParts)
protected void	registerOutputBuffers(org.zeroturnaround.exec.ProcessExecutor executor)
void	setDisableSslCheck(boolean flag)
void	setModuleMode(boolean value)
void	setWorkingDir(String path)

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GOARTIFACT_PACKAGING

public static final String GOARTIFACT_PACKAGING

See Also:

Constant Field Values

GO_MOD_FILE_NAME

public static final String GO_MOD_FILE_NAME

See Also:

Constant Field Values

GO_SUM_FILE_NAME

public static final String GO_SUM_FILE_NAME

See Also:

Constant Field Values

ENV_GO111MODULE

public static final String ENV_GO111MODULE

See Also:

Constant Field Values

NAME_PATTERN

public static final String NAME_PATTERN

VERSION, OS, PLATFORM,-OSXVERSION

See Also:

Constant Field Values

buildFlagsToIgnore

protected final Set<String> buildFlagsToIgnore

set of flags to be ignored among build and extra build flags, for inside use

tempBuildFlags

protected final List<String> tempBuildFlags

settings

@Parameter(defaultValue="${settings}",
           readonly=true)
protected org.apache.maven.settings.Settings settings

Constructor Detail

AbstractGolangMojo

public AbstractGolangMojo()

Method Detail

adaptExecNameForOS

@Nonnull
protected static String adaptExecNameForOS(@Nonnull
                                           String execName)

findExisting

@Nullable
protected static File findExisting(@Nonnull @MayContainNull
                                   File... files)

getWorkingDir

@Nullable
public final String getWorkingDir()

setWorkingDir

public final void setWorkingDir(@Nullable
                                String path)

isModuleMode

public boolean isModuleMode()

setModuleMode

public void setModuleMode(boolean value)

getArtifactResolver

@Nonnull
public org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolver getArtifactResolver()

getRemoteRepositories

@Nonnull
@MustNotContainNull
public List<org.apache.maven.artifact.repository.ArtifactRepository> getRemoteRepositories()

doesNeedSessionLock

protected boolean doesNeedSessionLock()

getTempFileFolder

@Nonnull
protected File getTempFileFolder()

isFilterEnvPath

public boolean isFilterEnvPath()

findMvnProperty

@Nullable
protected String findMvnProperty(@Nonnull
                                 String key,
                                 @Nullable
                                 String dflt)

isSkip

public boolean isSkip()

isEnforceGoPathToEnd

public boolean isEnforceGoPathToEnd()

getProject

@Nonnull
public org.apache.maven.project.MavenProject getProject()

getExecution

@Nonnull
public org.apache.maven.plugin.MojoExecution getExecution()

getSession

@Nonnull
public org.apache.maven.execution.MavenSession getSession()

isIgnoreErrorExitCode

public boolean isIgnoreErrorExitCode()

getEnv

@Nonnull
public Map<?,?> getEnv()

getSdkDownloadUrl

@Nullable
public String getSdkDownloadUrl()

getExecSubpath

@Nonnull
public String getExecSubpath()

getConnectionTimeout

public int getConnectionTimeout()

getExec

@Nonnull
public String getExec()

isUseEnvVars

public boolean isUseEnvVars()

isKeepSdkArchive

public boolean isKeepSdkArchive()

isKeepUnarchFolderIfError

public boolean isKeepUnarchFolderIfError()

getSdkArchiveName

@Nullable
public String getSdkArchiveName()

getReportsFolder

@Nonnull
public String getReportsFolder()

getOutLogFile

@Nullable
public String getOutLogFile()

getErrLogFile

@Nullable
public String getErrLogFile()

isCheckSdkHash

public boolean isCheckSdkHash()

getStoreFolder

@Nonnull
public String getStoreFolder()

getUseGoTool

@Nullable
public String getUseGoTool()

isVerbose

public boolean isVerbose()

isDisableSdkLoad

public boolean isDisableSdkLoad()

getSdkSite

@Nonnull
public String getSdkSite()

getBuildFlags

@Nonnull
@MustNotContainNull
public String[] getBuildFlags()

getExtraBuildFlags

@Nonnull
@MustNotContainNull
protected String[] getExtraBuildFlags()

findGoPath

@Nonnull
@MustNotContainNull
public File[] findGoPath(boolean ensureExist)
                  throws IOException

Throws:

IOException

findGoRootBootstrap

@Nullable
public File findGoRootBootstrap(boolean ensureExist)
                         throws IOException

Throws:

IOException

getOs

@Nonnull
public String getOs()

getArch

@Nullable
public String getArch()

getGoRoot

@Nullable
public String getGoRoot()

getGoCache

@Nullable
public String getGoCache()

getGoRootBootstrap

@Nullable
public String getGoRootBootstrap()

getGoBin

@Nullable
public String getGoBin()

getGoPath

@Nonnull
public String getGoPath()

getTargetArm

@Nullable
public String getTargetArm()

getTarget386

@Nullable
public String getTarget386()

getTargetOS

@Nullable
public String getTargetOS()

getTargetArch

@Nullable
public String getTargetArch()

isUseMavenProxy

public boolean isUseMavenProxy()

getSupposeSdkArchiveFileName

public boolean getSupposeSdkArchiveFileName()

isDisableSslCheck

public boolean isDisableSslCheck()

setDisableSslCheck

public void setDisableSslCheck(boolean flag)

getProxy

@Nullable
public ProxySettings getProxy()

getOSXVersion

@Nullable
public String getOSXVersion()

getGoVersion

@Nonnull
public String getGoVersion()

getSources

@Nonnull
public File getSources(boolean ensureExist)
                throws IOException

Throws:

IOException

addTmpBuildFlagIfNotPresented

protected void addTmpBuildFlagIfNotPresented(@Nonnull @MustNotContainNull
                                             String... flags)

logOptionally

protected void logOptionally(@Nonnull
                             String message)

initConsoleBuffers

protected void initConsoleBuffers()

findGoRoot

@Nonnull
protected File findGoRoot(@Nullable
                          ProxySettings proxySettings)
                   throws IOException,
                          org.apache.maven.plugin.MojoFailureException,
                          org.apache.maven.plugin.MojoExecutionException

Throws:

IOException

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

isHideBanner

public boolean isHideBanner()

doesNeedOneMoreAttempt

protected boolean doesNeedOneMoreAttempt(@Nonnull
                                         org.zeroturnaround.exec.ProcessResult result,
                                         @Nonnull
                                         String consoleOut,
                                         @Nonnull
                                         String consoleErr)
                                  throws IOException,
                                         org.apache.maven.plugin.MojoExecutionException

Throws:

IOException

org.apache.maven.plugin.MojoExecutionException

doLogging

protected void doLogging(int resultCode,
                         boolean error,
                         @Nonnull
                         String outLog,
                         @Nonnull
                         String errLog)
                  throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException

doMainBusiness

protected boolean doMainBusiness(@Nullable
                                 ProxySettings proxySettings,
                                 int maxAttempts)
                          throws InterruptedException,
                                 org.apache.maven.plugin.MojoFailureException,
                                 org.apache.maven.plugin.MojoExecutionException,
                                 IOException

Throws:

InterruptedException

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

IOException

execute

public final void execute()
                   throws org.apache.maven.plugin.MojoExecutionException,
                          org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException

doInit

public void doInit()
            throws org.apache.maven.plugin.MojoFailureException,
                   org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

beforeExecution

public void beforeExecution(@Nullable
                            ProxySettings proxySettings)
                     throws org.apache.maven.plugin.MojoFailureException,
                            org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

afterExecution

public void afterExecution(@Nullable
                           ProxySettings proxySettings,
                           boolean error)
                    throws org.apache.maven.plugin.MojoFailureException,
                           org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException

isEnforcePrintOutput

public boolean isEnforcePrintOutput()

printLogs

protected void printLogs(boolean forcePrint,
                         boolean errorDetected,
                         @Nonnull
                         String outLog,
                         @Nonnull
                         String errLog)

isSourceFolderRequired

public boolean isSourceFolderRequired()

isMojoMustNotBeExecuted

public boolean isMojoMustNotBeExecuted()
                                throws org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoFailureException

getTailArguments

@Nonnull
@MustNotContainNull
public abstract String[] getTailArguments()

getOptionalExtraTailArguments

@Nonnull
@MustNotContainNull
public String[] getOptionalExtraTailArguments()

makeExecutableFileSubpath

@Nonnull
public String makeExecutableFileSubpath()

getGoCommand

@Nonnull
public abstract String getGoCommand()

getCommandFlags

@Nonnull
@MustNotContainNull
public abstract String[] getCommandFlags()

registerOutputBuffers

protected void registerOutputBuffers(@Nonnull
                                     org.zeroturnaround.exec.ProcessExecutor executor)

registerEnvVars

protected void registerEnvVars(@Nonnull
                               org.zeroturnaround.exec.ProcessExecutor result,
                               @Nonnull
                               File theGoRoot,
                               @Nullable
                               String theGoBin,
                               @Nullable
                               String theGoCache,
                               @Nonnull
                               File sourcesFile,
                               @MustNotContainNull @Nonnull
                               File[] goPathParts)
                        throws IOException

Throws:

IOException

findAllGoModsInFolder

@Nonnull
@MustNotContainNull
protected List<File> findAllGoModsInFolder(@Nonnull @MustNotContainNull
                                           File folder)
                                    throws IOException

Throws:

IOException

getWorkingDirectoryForExecutor

@Nonnull
protected File getWorkingDirectoryForExecutor()
                                       throws IOException

Throws:

IOException

getSpecialPartOfGoPath

@Nonnull
protected String getSpecialPartOfGoPath()

Internal method which returns special part of GOPATH which can be formed by mojos. Must be either empty or contain folders divided by file path separator.

Returns:

special part of GOPATH, must not be null, by default must be empty

makePathFromExtraGoPathElements

@Nonnull
protected String makePathFromExtraGoPathElements()

isCommandSupportVerbose

public boolean isCommandSupportVerbose()

getSkipMojoPropertySuffix

@Nullable
protected String getSkipMojoPropertySuffix()

prepareExecutor

@Nullable
protected org.zeroturnaround.exec.ProcessExecutor prepareExecutor(@Nullable
                                                                  ProxySettings proxySettings)
                                                           throws IOException,
                                                                  org.apache.maven.plugin.MojoFailureException,
                                                                  org.apache.maven.plugin.MojoExecutionException

Throws:

IOException

org.apache.maven.plugin.MojoFailureException

org.apache.maven.plugin.MojoExecutionException