Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Introduce support to use locally installed ballerina distribution for the connector build #167

Merged
merged 12 commits into from
Aug 7, 2024
Merged

Introduce support to use locally installed ballerina distribution for the connector build #167

Changes from 6 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
df3d494
Remove buildOnDocker variable from the plugin
ayeshLK Aug 5, 2024
22754fe
Remove docker based execution for plugin-build tasks
ayeshLK Aug 5, 2024
f3e9289
Remove unused parameters and configurations
ayeshLK Aug 5, 2024
bab74a6
Add new tasks to verify the locally installed and configured ballerin…
ayeshLK Aug 5, 2024
112d12e
Restructure the code
ayeshLK Aug 5, 2024
f40ca17
Incorporate review suggestions
ayeshLK Aug 6, 2024
4ae17cc
Restructure build-dependent tasks
ayeshLK Aug 6, 2024
a45b7c3
Restructure bal-version parsing error handling logic
ayeshLK Aug 6, 2024
1d7b800
Restructure build task depedencies
ayeshLK Aug 6, 2024
3f722d6
Restructure build task depedencies
ayeshLK Aug 6, 2024
56c535c
Fix issue in jbalTools download logic
ayeshLK Aug 6, 2024
55570ed
Print warning log for using local bal-distribution in depedencies block
ayeshLK Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
197 changes: 74 additions & 123 deletions src/main/groovy/io/ballerina/plugin/BallerinaPlugin.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
package io.ballerina.plugin

import org.apache.tools.ant.taskdefs.condition.Os
import org.gradle.api.GradleException
import org.gradle.api.InvalidUserDataException
import org.gradle.api.Plugin
import org.gradle.api.Project
Expand Down Expand Up @@ -49,7 +50,6 @@ class BallerinaPlugin implements Plugin<Project> {
def balBuildTarget = 'build/bal_build_target'
def balaArtifact = new File("$project.projectDir/build/bala_unzipped/")
def projectDirectory = new File("$project.projectDir")
def parentDirectory = new File("$projectDirectory.parent")
def ballerinaCentralAccessToken = System.getenv('BALLERINA_CENTRAL_ACCESS_TOKEN')
def groupParams = ''
def disableGroups = ''
Expand All @@ -60,9 +60,8 @@ class BallerinaPlugin implements Plugin<Project> {
def needPublishToLocalCentral = false
def graalvmFlag = ''
def parallelTestFlag = ''
def buildOnDocker = false
def ballerinaDockerTag = ''
def distributionBinPath = ''
def ignoreVersionMismatch = false

if (project.version.matches(project.ext.timestampedVersionRegex)) {
def splitVersion = project.version.split('-')
Expand All @@ -88,8 +87,8 @@ class BallerinaPlugin implements Plugin<Project> {
}

project.dependencies {
if (buildOnDocker) {
println("[Warning] skipping downloading jBallerinaTools dependency: project uses docker to build the module")
if (ballerinaExtension.isConnector) {
println("[Warning] skipping downloading jBallerinaTools dependency: project uses locally installed Ballerina distribution to build the module")
ayeshLK marked this conversation as resolved.
Show resolved Hide resolved
} else {
if (ballerinaExtension.langVersion == null) {
jbalTools("org.ballerinalang:jballerina-tools:${ballerinaExtension.langVersion}") {
Expand All @@ -110,8 +109,8 @@ class BallerinaPlugin implements Plugin<Project> {
}
}

if (buildOnDocker) {
println("[Warning] skipping task 'unpackJballerinaTools': project uses docker to build the module")
if (ballerinaExtension.isConnector) {
println("[Warning] skipping downloading jBallerinaTools dependency: project uses locally installed Ballerina distribution to build the module")
ayeshLK marked this conversation as resolved.
Show resolved Hide resolved
} else {
doLast {
project.configurations.jbalTools.resolvedConfiguration.resolvedArtifacts.each { artifact ->
Expand All @@ -136,8 +135,8 @@ class BallerinaPlugin implements Plugin<Project> {

project.tasks.register('unpackStdLibs') {
dependsOn(project.unpackJballerinaTools)
if (buildOnDocker) {
println("[Warning] skipping task 'unpackStdLibs': project uses docker to build the module")
if (ballerinaExtension.isConnector) {
println("[Warning] skipping downloading jBallerinaTools dependency: project uses locally installed Ballerina distribution to build the module")
} else {
doLast {
project.configurations.ballerinaStdLibs.resolvedConfiguration.resolvedArtifacts.each { artifact ->
Expand All @@ -152,8 +151,8 @@ class BallerinaPlugin implements Plugin<Project> {

project.tasks.register('copyStdlibs') {
dependsOn(project.unpackStdLibs)
if (buildOnDocker) {
println("[Warning] skipping task 'copyStdlibs': project uses docker to build the module")
if (ballerinaExtension.isConnector) {
println("[Warning] skipping downloading jBallerinaTools dependency: project uses locally installed Ballerina distribution to build the module")
} else {
doLast {
/* Standard Libraries */
Expand Down Expand Up @@ -185,13 +184,6 @@ class BallerinaPlugin implements Plugin<Project> {
}

project.tasks.register('initializeVariables') {
if (ballerinaExtension.isConnector || project.hasProperty('buildUsingDocker')) {
buildOnDocker = true
ballerinaDockerTag = getDockerImageTag(project)
println("[Info] project builds on docker")
println("[Info] using the Ballerina docker image tag: $ballerinaDockerTag")
}

String packageName = ballerinaExtension.module
String organization
if (ballerinaExtension.packageOrganization == null) {
Expand Down Expand Up @@ -235,10 +227,61 @@ class BallerinaPlugin implements Plugin<Project> {
testCoverageParams = ballerinaExtension.testCoverageParam
}
}

if (project.hasProperty("ignoreVersionMismatch")) {
ignoreVersionMismatch = true
}
}

project.tasks.register('build') {
project.tasks.register("verifyLocalBalVersion") {
dependsOn(project.initializeVariables)

if (!ballerinaExtension.isConnector) {
return
}

def output = new ByteArrayOutputStream()
def error = new ByteArrayOutputStream()

try {
exec {
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
commandLine 'cmd', '/c', "bal.bat -v"
} else {
commandLine 'sh', '-c', "bal -v"
}
standardOutput = output
errorOutput = error
ignoreExitValue = true
}
} catch (Exception e) {
throw new GradleException("Ballerina installation not found, hence exiting", e)
}

def versionOutput = output.toString()
def installedVersion = ""
try {
def balVersion = versionOutput.split("\n")[0]
installedVersion = balVersion
.replaceAll("Ballerina ", '')
.replaceAll("\\(Swan Lake Update \\d+\\)", '')
.replaceAll("\\s+", '')
} catch (Exception e) {
throw new GradleException("Failed to parse the Ballerina version: $versionOutput", e)
}
ayeshLK marked this conversation as resolved.
Show resolved Hide resolved

def configuredVersion = project.findProperty('ballerinaLangVersion')
if (installedVersion != configuredVersion) {
if (ignoreVersionMismatch) {
println("[Warning] Ignoring Ballerina version mismatch. Expected: $configuredVersion, but found: $installedVersion.")
return
}
throw new GradleException("Ballerina version mismatch. Expected: $configuredVersion, but found: $installedVersion, hence exiting")
}
}

project.tasks.register('build') {
dependsOn(project.verifyLocalBalVersion)
dependsOn(project.updateTomlFiles)
finalizedBy(project.commitTomlFiles)
dependsOn(project.test)
Expand Down Expand Up @@ -268,27 +311,11 @@ class BallerinaPlugin implements Plugin<Project> {
def result = project.exec {
workingDir project.projectDir
environment 'JAVA_OPTS', '-DBALLERINA_DEV_COMPILE_BALLERINA_ORG=true'
if (buildOnDocker) {
createDockerEnvFile("$project.projectDir/docker.env")
def balPackWithDocker = """
docker run --env-file $project.projectDir/docker.env --rm --net=host -u root \
-v $parentDirectory:/home/ballerina/$parentDirectory.name \
-v $projectDirectory:/home/ballerina/$parentDirectory.name/$projectDirectory.name \
ballerina/ballerina:$ballerinaDockerTag \
/bin/sh -c "cd $parentDirectory.name/$projectDirectory.name && \
bal pack --target-dir ${balBuildTarget}"
"""
if (ballerinaExtension.isConnector) {
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
println "Executing command on windows: ${balPackWithDocker}"
// commandLine 'cmd', '/c', "$balPackWithDocker && exit %%ERRORLEVEL%%"
def cmdStr = """
docker run --env-file $project.projectDir/docker.env --rm --net=host -u root \
alpine:latest \
/bin/sh -c "ls -al"
"""
commandLine 'cmd', '/c', "$balPackWithDocker && exit %%ERRORLEVEL%%"
commandLine 'cmd', '/c', "bal.bat pack --target-dir ${balBuildTarget} && exit %%ERRORLEVEL%%"
} else {
commandLine 'sh', '-c', "$balPackWithDocker"
commandLine 'sh', '-c', "bal pack --target-dir ${balBuildTarget}"
}
} else {
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
Expand Down Expand Up @@ -328,19 +355,11 @@ class BallerinaPlugin implements Plugin<Project> {
project.exec {
workingDir project.projectDir
environment 'JAVA_OPTS', '-DBALLERINA_DEV_COMPILE_BALLERINA_ORG=true'
if (buildOnDocker) {
def balPushWithDocker = """
docker run --env-file $project.projectDir/docker.env --rm --net=host -u root \
-v $parentDirectory:/home/ballerina/$parentDirectory.name \
-v $projectDirectory:/home/ballerina/$parentDirectory.name/$projectDirectory.name \
ballerina/ballerina:$ballerinaDockerTag \
/bin/sh -c "cd $parentDirectory.name/$projectDirectory.name && \
bal push ${balBuildTarget}/bala/${packageOrg}-${packageName}-${platform}-${balaVersion}.bala"
"""
if (ballerinaExtension.isConnector) {
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
commandLine 'cmd', '/c', "$balPushWithDocker && exit %%ERRORLEVEL%%"
commandLine 'cmd', '/c', "bal.bat push ${balBuildTarget}/bala/${packageOrg}-${packageName}-${platform}-${balaVersion}.bala && exit %%ERRORLEVEL%%"
} else {
commandLine 'sh', '-c', "$balPushWithDocker"
commandLine 'sh', '-c', "bal push ${balBuildTarget}/bala/${packageOrg}-${packageName}-${platform}-${balaVersion}.bala"
}
} else if (Os.isFamily(Os.FAMILY_WINDOWS)) {
commandLine 'cmd', '/c', "$distributionBinPath/bal.bat push ${balBuildTarget}/bala/${packageOrg}-${packageName}-${platform}-${balaVersion}.bala && exit %%ERRORLEVEL%%"
Expand Down Expand Up @@ -371,9 +390,6 @@ class BallerinaPlugin implements Plugin<Project> {
}
}
}
if (buildOnDocker) {
deleteFile("$project.projectDir/docker.env")
}
}
outputs.dir balaArtifact
}
Expand All @@ -384,28 +400,19 @@ class BallerinaPlugin implements Plugin<Project> {
}

project.tasks.register('test') {
dependsOn(project.initializeVariables)
dependsOn(project.verifyLocalBalVersion)
dependsOn(project.updateTomlFiles)
finalizedBy(project.commitTomlFiles)
doLast {
// Run tests
project.exec {
workingDir project.projectDir
environment 'JAVA_OPTS', '-DBALLERINA_DEV_COMPILE_BALLERINA_ORG=true'
if (buildOnDocker) {
createDockerEnvFile("$project.projectDir/docker.env")
def balTestWithDocker = """
docker run --env-file $project.projectDir/docker.env --rm --net=host -u root \
-v $parentDirectory:/home/ballerina/$parentDirectory.name \
-v $projectDirectory:/home/ballerina/$parentDirectory.name/$projectDirectory.name \
ballerina/ballerina:$ballerinaDockerTag \
/bin/sh -c "cd $parentDirectory.name/$projectDirectory.name && \
$balJavaDebugParam bal test ${graalvmFlag} ${parallelTestFlag} ${testCoverageParams} ${groupParams} ${disableGroups} ${debugParams}"
"""
if (ballerinaExtension.isConnector) {
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
commandLine 'cmd', '/c', "$balTestWithDocker && exit %%ERRORLEVEL%%"
commandLine 'cmd', '/c', "bal.bat test --offline ${graalvmFlag} ${parallelTestFlag} ${testCoverageParams} ${groupParams} ${disableGroups} ${debugParams} && exit %%ERRORLEVEL%%"
} else {
commandLine 'sh', '-c', "$balTestWithDocker"
commandLine 'sh', '-c', "bal test --offline ${graalvmFlag} ${parallelTestFlag} ${testCoverageParams} ${groupParams} ${disableGroups} ${debugParams}"
}
} else if (Os.isFamily(Os.FAMILY_WINDOWS)) {
commandLine 'cmd', '/c', "$balJavaDebugParam $distributionBinPath/bal.bat test --offline ${graalvmFlag} ${parallelTestFlag} ${testCoverageParams} ${groupParams} ${disableGroups} ${debugParams} && exit %%ERRORLEVEL%%"
Expand All @@ -414,69 +421,13 @@ class BallerinaPlugin implements Plugin<Project> {
}

}
if (buildOnDocker) {
deleteFile("$project.projectDir/docker.env")
}
}
}

project.tasks.register('clean', Delete.class) {
if (buildOnDocker) {
project.exec {
def deleteUsingDocker = """
docker run -u root \
-v $parentDirectory:/home/ballerina/$parentDirectory.name \
ballerina/ballerina:$ballerinaDockerTag \
/bin/sh -c "find /home/ballerina/$parentDirectory.name -type d -name 'build' -exec rm -rf {} + && find /home/ballerina/$parentDirectory.name -type d -name 'target' -exec rm -rf {} +"
"""
if (Os.isFamily(Os.FAMILY_WINDOWS)) {
commandLine 'cmd', '/c', "$deleteUsingDocker && exit %%ERRORLEVEL%%"
} else {
commandLine 'sh', '-c', "$deleteUsingDocker"
}
}
} else {
delete "$project.projectDir/target"
delete "$project.projectDir/build"
}
delete "$project.projectDir/target"
delete "$project.projectDir/build"
delete "$project.rootDir/target"
}
}

static void createDockerEnvFile(String dockerEnvFilePath) {
def dockerEnvFileWriter = new PrintWriter("$dockerEnvFilePath", "UTF-8")
def excludedVariables = ["PATH", "JAVA_HOME", "HOME"]
def envVariables = System.getenv()
envVariables.each { key, value ->
if (!excludedVariables.contains(key) && !key.startsWith("=")) {
dockerEnvFileWriter.println("$key=$value")
}
}
dockerEnvFileWriter.close()
}

static void deleteFile(String filePath) {
def file = new File(filePath)
if (file.exists() && !file.delete()) {
println("Failed to delete $filePath.")
}
}

static String getDockerImageTag(Project project) {
def ballerinaDockerTag = project.findProperty('ballerinaLangVersion')
if (project.hasProperty('buildUsingDocker')) {
ballerinaDockerTag = project.findProperty('buildUsingDocker')
if (ballerinaDockerTag == '') {
return 'nightly'
}
}
if (isTimeStampVersion(ballerinaDockerTag)) {
return 'nightly'
}
return ballerinaDockerTag
}

static boolean isTimeStampVersion(String version) {
return version.trim().split("-").length > 1
}
}
Loading