doytsujin / gogradle

A Golang plugin for building, testing, dependency management and popular frameworks (gRPC, Gin, Swagger, ...) supported

Note: Before using this plugin, please note that there is no test coverage right now, but it will be done in near future.

What is gogradle

A Gradle plugin supports Go module/package build lifecycle, also integrate go modules started from Go 1.11 for dependency management.

Installation

https://plugins.gradle.org/plugin/com.pivotstir.gogradle

plugins {
  id "com.pivotstir.gogradle" version "1.1.3"
}

Tasks

Gogradle tasks
--------------
goBuild - Build Go project
goClean - Clean Go project
goDep - Resolve Go project library and 3rd party tool dependencies
goEnv - Setup Go environment
goGrpc - Generate gRPC and Protobuf code
goSwag - Generate Swagger files for Gin project, supported by github.com/swaggo/gin-swagger
goTest - Test Go project

Configurations

build.gradle

go {
    // Change module path from default project name
    pluginConfig.modulePath = ""

    build {
        // extra options/flags of `go build`
        cmdArgs = []
        
        // extra envirnment variables of `go build`
        envs = ["CGO_ENABLED": 0]
        
        // crossplatform build. Default: if empty or not specified, just build for local platform
        osArches = [
            "darwin/amd64", 
            "linux/amd64", 
            "windows/amd64"
        ]
        
        // package paths to build. 
        packagePaths = [
            "./cmd/package1"
            "./cmd/package2"
        ]
    }
    
    dep {
        // extra options/flags of `go get` for downloading package dependencies
        cmdArgs = []
            
        // extra envirnment variables of `go get` for downloading package dependencies
        envs = ["CGO_ENABLED": 0]
        
        // ignore third party tools download like Protobuf, Swaggo
        thirdpartyIgnored = false
        
        // Protobuf version for downloading protobuf toolset. Default: "3.6.1"
        protoVersion = "3.8.0"
        
        // version of https://github.com/swaggo/swag
        swaggoVersion = "1.5.1"
    }
    
    env {
        // go version. Default: "1.12.6"
        version = "1.12"
        
        // use project level go installation. Default: true
        useSandbox = true
    }
    
    grpc {
        // Protobuf schemas root folder. Default: file("proto")
        protoDir = file("proto")
        
        // Append the module path as prefix path of below packages when referenced in other protobuf gnerated stub go files
        referencePackages = []
    }

    test {
        // extra options/flags of `go test`
        cmdArgs = []
            
        // extra envirnment variables of `go test`
        envs = ["CGO_ENABLED": 0]
        
        // ignore folders for testing
        ignoredDirs = ["abc"]
    }

    dependencies {
        build "github.com/golang/[email protected]"
        test "github.com/stretchr/[email protected]"
    }
}

build.gradle.kts

extensions.getByType(GoPluginExtension::class).apply {
    env {
        useSandbox = true
    }

    build {
        packagePaths = listOf("./cmd/package1", "./cmd/package2")
    }

    dep {
        thirdpartyIgnored = false
    }

    dependencies {
        build("github.com/golang/[email protected]")
        test("github.com/stretchr/[email protected]")
    }
}

Go Environment

gralde goenv, setup Go environment in .gogradle

gRPC Support

gralde godep, besides resolving package dependencies, setup environments for popular go frameworks (gRPC, gRPC gateway, Gin-Swagger)

gralde gogrpc, generate gRPC stubs from protobuf schemas and swagger files for gRPC gateway support

Swagger Support

gralde goswag, generate swagger files for Gin-Swagger support

Dependencies Management

gralde godep, resolve packages build/test dependencies in gogradle DSL, then create/update go.mod and download all dependent packages.

Test

gralde gotest, run testing, also support ignored folders and different coverage reports (json, xml). XML is Cobertura compatible.

Custom Go Task

import com.pivotstir.gogradle.tasks.Go

task myTask(type: Go) {
    go("help test", [:])
    go("help build", [:])
}