Merge pull request #818 from wangkuiyi/bazel-protobuf

Bazel protobuf and gtest

.gitignore

@@ -9,3 +9,6 @@ build/
 .pydevproject
 Makefile
 .test_env/
+
+*~
+bazel-*

.pre-commit-config.yaml

@@ -6,7 +6,8 @@
 -   repo: https://github.com/reyoung/mirrors-yapf.git
     sha: v0.13.2
     hooks:
-    -   id: yapf
+    - id: yapf
+      files: (.*\.(py|bzl)|BUILD|.*\.BUILD|WORKSPACE)$  # Bazel BUILD files follow Python syntax.
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     sha: 7539d8bd1a00a3c1bfd34cdb606d3a6372e83469
     hooks:

WORKSPACE

+# External dependency to Google protobuf.
+http_archive(
+    name = "protobuf",
+    url = "http://github.com/google/protobuf/archive/v3.1.0.tar.gz",
+    sha256 = "0a0ae63cbffc274efb573bdde9a253e3f32e458c41261df51c5dbc5ad541e8f7",
+    strip_prefix = "protobuf-3.1.0",
+)
+
+# External dependency to gtest 1.7.0.  This method comes from
+# https://www.bazel.io/versions/master/docs/tutorial/cpp.html.
+new_http_archive(
+    name = "gtest",
+    url = "https://github.com/google/googletest/archive/release-1.7.0.zip",
+    sha256 = "b58cb7547a28b2c718d1e38aee18a3659c9e3ff52440297e965f5edffe34b6d0",
+    build_file = "third_party/gtest.BUILD",
+    strip_prefix = "googletest-release-1.7.0",
+)

doc/getstarted/build_and_install/docker_install_en.rst

@@ -104,3 +104,70 @@ container:
 
 Then we can direct our Web browser to the HTML version of source code
 at http://localhost:8088/paddle/
+
+
+Development Using Docker
+------------------------
+
+Develpers can work on PaddlePaddle using Docker.  This allows
+developers to work on different platforms -- Linux, Mac OS X, and
+Windows -- in a consistent way.
+
+The general development workflow with Docker and Bazel is as follows:
+
+1. Get the source code of Paddle:
+
+   .. code-block:: bash
+
+      git clone --recursive https://github.com/paddlepaddle/paddle
+
+
+2. Build a development Docker image `paddle:dev` from the source code.
+   This image contains all the development tools and dependencies of
+   PaddlePaddle.
+
+
+   .. code-block:: bash
+
+      cd paddle
+      docker build -t paddle:dev -f paddle/scripts/docker/Dockerfile .
+
+
+3. Run the image as a container and mounting local source code
+   directory into the container.  This allows us to change the code on
+   the host and build it within the container.
+
+   .. code-block:: bash
+
+      docker run \
+       -d # run the container in background mode \
+       --name paddle # we can run a nginx container to serve documents \
+       -p 2022:22    # so we can SSH into this container \
+       -v $PWD:/paddle # mount the source code \
+       -v $HOME/.cache/bazel:/root/.cache/bazel # mount Bazel cache \
+       paddle:dev
+
+4. SSH into the container:
+
+   .. code-block:: bash
+
+      ssh root@localhost -p 2022
+
+5. We can edit the source code in the container or on this host.  Then
+   we can build using cmake
+
+   .. code-block:: bash
+
+      cd /paddle # where paddle source code has been mounted into the container
+      mkdir -p build
+      cd build
+      cmake -DWITH_TESTING=ON ..
+      make -j `nproc`
+      CTEST_OUTPUT_ON_FAILURE=1 ctest
+
+   or Bazel in the container:
+
+   .. code-block:: bash
+
+      cd /paddle
+      bazel test ...

third_party/gtest.BUILD

+cc_library(
+    name = "main",
+    srcs = glob(
+        ["src/*.cc"],
+        exclude = ["src/gtest-all.cc"]
+    ),
+    hdrs = glob([
+        "include/**/*.h",
+        "src/*.h"
+    ]),
+    copts = ["-Iexternal/gtest/include"],
+    linkopts = ["-pthread"],
+    visibility = ["//visibility:public"],
+)

third_party/protobuf_test/BUILD

+licenses(["notice"])  # Apache 2.0
+
+load("@protobuf//:protobuf.bzl", "cc_proto_library")
+
+cc_proto_library(
+    name = "example_proto",
+    srcs = ["example.proto"],
+    protoc = "@protobuf//:protoc",
+    default_runtime = "@protobuf//:protobuf",
+)
+
+cc_library(
+    name = "example_lib",
+    srcs = ["example_lib.cc"],
+    hdrs = ["example_lib.h"],
+    deps = [":example_proto"],
+)
+
+cc_test(
+    name = "example_lib_test",
+    srcs = ["example_lib_test.cc"],
+    copts = ["-Iexternal/gtest/include"],
+    deps =[
+        "@gtest//:main",
+        ":example_lib",
+    ],
+)

third_party/protobuf_test/README.md

+This package tests that Bazel can build protobuf related rules.

third_party/protobuf_test/example.proto

+syntax = "proto3";
+
+package third_party.protobuf_test;
+
+message Greeting {
+  string name = 1;
+}

third_party/protobuf_test/example_lib.cc

+#include "third_party/protobuf_test/example_lib.h"
+
+namespace third_party {
+namespace protobuf_test {
+
+std::string get_greet(const Greeting& who) {
+  return "Hello " + who.name();
+}
+
+}  // namespace protobuf_test
+}  // namespace thrid_party

third_party/protobuf_test/example_lib.h

+#pragma once
+
+#include "third_party/protobuf_test/example.pb.h"
+
+#include <string>
+
+namespace third_party {
+namespace protobuf_test {
+
+std::string get_greet(const Greeting &who);
+
+}  // namespace protobuf_test
+}  // namespace third_party

third_party/protobuf_test/example_lib_test.cc

+#include "third_party/protobuf_test/example_lib.h"
+
+#include "gtest/gtest.h"
+
+namespace third_party {
+namespace protobuf_test {
+
+TEST(ProtobufTest, GetGreet) {
+  Greeting g;
+  g.set_name("Paddle");
+  EXPECT_EQ("Hello Paddle", get_greet(g));
+}
+
+}  // namespace protobuf_test
+}  // namespace third_party