Package com.microsoft.azure.maven.function

Class RunMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.microsoft.azure.maven.AbstractAzureMojo

com.microsoft.azure.maven.appservice.AbstractAppServiceMojo

com.microsoft.azure.maven.function.AbstractFunctionMojo

com.microsoft.azure.maven.function.RunMojo

All Implemented Interfaces:

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

@Mojo(name="run")
public class RunMojo
extends AbstractFunctionMojo

Run Azure Java Functions locally. Azure Functions Core Tools is required to be installed first.

Nested Class Summary

Nested classes/interfaces inherited from class com.microsoft.azure.maven.AbstractAzureMojo

com.microsoft.azure.maven.AbstractAzureMojo.DefaultUncaughtExceptionHandler, com.microsoft.azure.maven.AbstractAzureMojo.RunnableWithException

Field Summary

Fields

Modifier and Type	Field	Description
private static org.apache.maven.artifact.versioning.ComparableVersion	FUNC_3
protected static String	FUNC_CMD
protected static String	FUNC_HOST_START_CMD
private static String	FUNC_HOST_START_WITH_DEBUG_CMD
private static String	FUNC_VERSION_CMD
protected Integer	funcPort	Config port for function local host
private static String	FUNCTION_CORE_TOOLS_OUT_OF_DATE
private static org.apache.maven.artifact.versioning.ComparableVersion	JAVA_9
protected String	localDebugConfig	Config String for local debug
private static org.apache.maven.artifact.versioning.ComparableVersion	MINIMUM_JAVA_9_SUPPORTED_VERSION
private static org.apache.maven.artifact.versioning.ComparableVersion	MINIMUM_JAVA_9_SUPPORTED_VERSION_V2
protected static String	RUN_FUNCTIONS_FAILURE
private static String	RUNTIME_FOUND
protected static String	RUNTIME_NOT_FOUND
private static String	STAGE_DIR_FOUND
private static String	STAGE_DIR_NOT_FOUND

Fields inherited from class com.microsoft.azure.maven.function.AbstractFunctionMojo

alwaysReadyInstances, appInsightsInstance, appInsightsKey, artifactPath, AZURE_FUNCTIONS_JAVA_LIBRARY, CAN_NOT_FIND_ARTIFACT, disableAppInsights, finalName, FUNCTION_EXTENSION_LIBRARY_MAP, HOST_JSON, hostJson, instanceSize, LOCAL_SETTINGS_JSON, localSettingsJson, maximumInstances, outputDirectory, parser, pricingTier, region, runtime, skip, storageAccountName, storageAccountResourceGroup, TRIGGER_TYPE

Fields inherited from class com.microsoft.azure.maven.appservice.AbstractAppServiceMojo

appName, appServiceClient, appServicePlanName, appServicePlanResourceGroup, appSettings, deploymentSlotSetting, MAVEN_PLUGIN_POSTFIX, resourceGroup

Fields inherited from class com.microsoft.azure.maven.AbstractAzureMojo

allowTelemetry, auth, authType, buildDirectory, COMPILE_LEVEL_NOT_SUPPORTED, FAILED_TO_GET_VALID_RUNTIMES, failsOnError, failsOnRuntimeValidationError, INSTALLATION_ID_KEY, mavenResourcesFiltering, plugin, PLUGIN_NAME_KEY, PLUGIN_VERSION_KEY, project, session, SESSION_ID_KEY, settings, settingsDecrypter, SUBSCRIPTION_ID_KEY, SUBSCRIPTION_NOT_FOUND, SUBSCRIPTION_TEMPLATE, subscriptionId, telemetries, telemetryProxy, USING_AZURE_ENVIRONMENT

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

ROLE

Constructor Summary

Constructors

Constructor	Description
RunMojo()

Method Summary

Modifier and Type	Method	Description
private void	checkRuntimeCompatibility(com.microsoft.azure.toolkit.lib.legacy.function.handlers.CommandHandler handler)
protected void	checkRuntimeExistence(com.microsoft.azure.toolkit.lib.legacy.function.handlers.CommandHandler handler)
protected void	checkStageDirectoryExistence()
protected void	doExecute()
protected String	getCheckRuntimeCommand()
String	getLocalDebugConfig()
protected String	getStartFunctionHostCommand()
protected String	getStartFunctionHostWithDebugCommand()
protected void	runFunctions(com.microsoft.azure.toolkit.lib.legacy.function.handlers.CommandHandler handler)
void	setLocalDebugConfig(String localDebugConfig)

Methods inherited from class com.microsoft.azure.maven.function.AbstractFunctionMojo

getAppInsightsInstance, getAppInsightsKey, getArtifact, getBundleVersion, getFinalName, getFunctionLibraryVersion, getHostJsonFile, getLocalSettingsJsonFile, getRegion, getRuntimeConfiguration, getTelemetryProperties, isDisableAppInsights, isSkipMojo, readHostJson, validateAppName, validateFunctionCompatibility

Methods inherited from class com.microsoft.azure.maven.appservice.AbstractAppServiceMojo

getAppName, getAppServicePlanName, getAppServicePlanResourceGroup, getAppSettings, getDeploymentSlotSetting, getDeploymentStagingDirectoryPath, getResourceGroup, getResources, initAzureAppServiceClient, printCurrentSubscription

Methods inherited from class com.microsoft.azure.maven.AbstractAzureMojo

afterMojoExecution, beforeMojoExecution, checkSubscription, execute, executeWithTimeRecorder, getActualAuthType, getAllowTelemetry, getBuildDirectoryAbsolutePath, getCompileLevel, getFailsOnError, getFailsOnRuntimeValidationError, getInstallationId, getMavenResourcesFiltering, getPluginName, getPluginVersion, getProject, getSession, getSessionId, getSettings, getSubscriptionId, getTargetSubscriptionId, getTelemetries, getTelemetryProxy, getUserAgent, getValidRuntimes, highlightDefaultValue, infoWithMultipleLines, initTelemetryProxy, loginAzure, loginAzure, onMojoError, onSkipped, printCredentialDescription, selectSubscription, selectSubscription, trackMojoFailure, updateTelemetryProperties, validateArtifactCompileVersion

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

FUNC_CMD

protected static final String FUNC_CMD

See Also:

Constant Field Values

FUNC_HOST_START_CMD

protected static final String FUNC_HOST_START_CMD

See Also:

Constant Field Values

RUN_FUNCTIONS_FAILURE

protected static final String RUN_FUNCTIONS_FAILURE

See Also:

Constant Field Values

RUNTIME_NOT_FOUND

protected static final String RUNTIME_NOT_FOUND

See Also:

Constant Field Values

STAGE_DIR_FOUND

private static final String STAGE_DIR_FOUND

See Also:

Constant Field Values

STAGE_DIR_NOT_FOUND

private static final String STAGE_DIR_NOT_FOUND

See Also:

Constant Field Values

RUNTIME_FOUND

private static final String RUNTIME_FOUND

See Also:

Constant Field Values

FUNC_HOST_START_WITH_DEBUG_CMD

private static final String FUNC_HOST_START_WITH_DEBUG_CMD

See Also:

Constant Field Values

JAVA_9

private static final org.apache.maven.artifact.versioning.ComparableVersion JAVA_9

FUNC_3

private static final org.apache.maven.artifact.versioning.ComparableVersion FUNC_3

MINIMUM_JAVA_9_SUPPORTED_VERSION

private static final org.apache.maven.artifact.versioning.ComparableVersion MINIMUM_JAVA_9_SUPPORTED_VERSION

MINIMUM_JAVA_9_SUPPORTED_VERSION_V2

private static final org.apache.maven.artifact.versioning.ComparableVersion MINIMUM_JAVA_9_SUPPORTED_VERSION_V2

FUNC_VERSION_CMD

private static final String FUNC_VERSION_CMD

See Also:

Constant Field Values

FUNCTION_CORE_TOOLS_OUT_OF_DATE

private static final String FUNCTION_CORE_TOOLS_OUT_OF_DATE

See Also:

Constant Field Values

localDebugConfig

@Parameter(property="localDebugConfig",
           defaultValue="transport=dt_socket,server=y,suspend=n,address=5005")
protected String localDebugConfig

Config String for local debug

Since:

1.0.0-beta-7

funcPort

@Parameter(property="funcPort",
           defaultValue="7071")
protected Integer funcPort

Config port for function local host

Since:

1.22.0

Constructor Detail

RunMojo

public RunMojo()

Method Detail

getLocalDebugConfig

public String getLocalDebugConfig()

setLocalDebugConfig

public void setLocalDebugConfig(String localDebugConfig)

doExecute

protected void doExecute()
                  throws com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

Specified by:

doExecute in class com.microsoft.azure.maven.AbstractAzureMojo

Throws:

com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

checkStageDirectoryExistence

protected void checkStageDirectoryExistence()
                                     throws com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

Throws:

com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

checkRuntimeExistence

protected void checkRuntimeExistence(com.microsoft.azure.toolkit.lib.legacy.function.handlers.CommandHandler handler)
                              throws com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

Throws:

com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

runFunctions

protected void runFunctions(com.microsoft.azure.toolkit.lib.legacy.function.handlers.CommandHandler handler)
                     throws com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

Throws:

com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

checkRuntimeCompatibility

private void checkRuntimeCompatibility(com.microsoft.azure.toolkit.lib.legacy.function.handlers.CommandHandler handler)
                                throws com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

Throws:

com.microsoft.azure.toolkit.lib.common.exception.AzureExecutionException

getCheckRuntimeCommand

protected String getCheckRuntimeCommand()

getStartFunctionHostCommand

protected String getStartFunctionHostCommand()

getStartFunctionHostWithDebugCommand

protected String getStartFunctionHostWithDebugCommand()