Example : generate for GO

[fiftoine]

Hi,

From a set of proto files, I would like to generate stubs for both java and go.

Reading the doc I can't find a way of generating stubs for go even if it's mentioned in others issues.

Could you provide an example on how to generate for go alone and for java and go?

Thanks in advance

[zhangkun83]

You should follow the Step 2 from the protobuf documentation to install the Go protocol buffers plugin.

Then add go {} to the plugins of all protobuf generating tasks:

protobuf {
  generateProtoTasks {
    all().each { task ->
      task.plugins {
        go { }
      }
    }
  }
}

Run ./gradlew generateProto and you should find the generated files under build/generated/source/proto. We have done nothing to integrate the generated files into Go compilation, you would have to wire them up manually.

[Groostav]

@zhangkun83 what about extending this to grpc?

specifically im interested in C#, and I've been trying to create a workaround a le:

        generateProtoTasks {
            all().each { task ->
                task.plugins {
                    grpc {
                        logger.warn("TODO: currently not generating grpc for csharp, because protoc plugins on gradle plugins are NFG.")
//                        def path = file("$projectDir/../.kinda-nuget/packages/grpc.tools/1.15.0/tools/windows_x64/grpc_csharp_plugin.exe").absolutePath
//                        option "protoc-gen-grpc=$path"
                    }
                }
                task.builtins {
                    java { }
                    csharp { }
                }
            }
        }

[zhangkun83]

@Groostav, to use the C# grpc plugin, you would need to first define it, with either an artifact spec or a local path, e.g.,

protobuf {
  ...
  // Configure the codegen plugins
  plugins {
    // Define a plugin with name 'grpc'
    grpc {
      path = file("$projectDir/../.kinda-nuget/packages/grpc.tools/1.15.0/tools/windows_x64/grpc_csharp_plugin.exe").absolutePath
    }
    // Any other plugins
    ...
  }
  ...
}

[Groostav]

Works like a charm.

protobuf {

     protoc {
         artifact = "com.google.protobuf:protoc:3.5.1-1"
     }
     plugins {
         grpc_java {
             artifact = 'io.grpc:protoc-gen-grpc-java:1.15.1'
         }
         grpc_csharp {
             path = file("$projectDir/../.kinda-nuget/packages/grpc.tools/1.15.0/tools/windows_x64/grpc_csharp_plugin.exe").absolutePath
         }
     }

     generateProtoTasks {
         all().each { task ->
             task.plugins {
                 grpc_java {}
                 grpc_csharp {}
             }
             task.builtins {
                 java { }
                 csharp {}
             }
         }
     }
 }

The way I generated by .kinda-nuget was by copying a chunk of a nuget provided package into that folder. I didnt want to try and get gradle downloading nuget packages, so I simply checked that (multi-megabyte) portion into my repo. I don't think it'l be too volatile, though it does mean I'll have to do more work than simply changing a version string when I want to update grpc.

But, @zhangkun83, I cant help but feel I've hijacked the OPs quesiton and others googling "go grpc gradle", given that you cant simply put a path = file(".../grpc-go-plugin") there, what would the OP do?

[zhangkun83]

OP's problem could be solved by allowing referring "undefined" plugins, since protoc will search in $PATH for the plugin if its path is not specified. I have created #270 for that.

Unfortunately the CI is broken and we are short-staffed, and we can't make a release with CI broken. Any help to fix the CI is welcome.

[zhangkun83]

0.8.7 is released and includes #270