https://github.com/bazelbuild/codelabs

https://github.com/bazelbuild/codelabs

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/bazelbuild/codelabs
• Owner: bazelbuild
• License: apache-2.0
• Archived: true
• Created: 2018-10-08T02:44:59.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-06-02T21:03:00.000Z (about 4 years ago)
• Last Synced: 2025-03-16T13:26:53.894Z (over 1 year ago)
• Language: Shell
• Size: 130 KB
• Stars: 41
• Watchers: 30
• Forks: 36
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          
# Bazel Codelab

## Before you get started

Take a look at these [informational slides](https://docs.google.com/presentation/d/1vNuuY97NmxP85MLEheYcMDHbpFb6cwSYWPNloBqdrPM/edit#slide=id.p) to learn about Bazel.

## Section 1: Hello, Bazel!

1.  Edit: `java/src/main/java/bazel/bootcamp/BUILD`

1.  Add a `java_binary` target for the `HelloBazelBootcamp.java` file

    - [`java_binary` documentation](https://docs.bazel.build/versions/master/be/java.html#java_binary)

1.  Run the binary using `bazel run //java/src/main/java/bazel/bootcamp:HelloBazelBootcamp`

## Section 2: Go server

1.  Edit the `BUILD` file for `logger.proto`

    - [`proto_library` documentation](https://docs.bazel.build/versions/master/be/protocol-buffer.html#proto_library)

    - [`go_proto_library` documentation](https://github.com/bazelbuild/rules_go/blob/master/proto/core.rst#example-grpc)

     HintCheck out the compilers attribute for go_proto_library in the grpc example

     HintGo libraries each declare the import path at which they would like to be imported by other go files. server.go imports the proto file at bootcamp/proto/logger so the importpath attribute of go_proto_library should match that.

    

1.  Edit the `BUILD` file for `server.go`

    - [`go_binary` documentation](https://github.com/bazelbuild/rules_go/blob/master/go/core.rst#go_binary)    

1.  Run the go binary using `bazel run`

1.  Go to http://localhost:8081 to see results (there won't be any logs yet)

## Section 3: Java client

1.  Edit the `BUILD` file for `logger.proto`

    - [`java_proto_library` documentation](https://docs.bazel.build/versions/master/be/java.html#java_proto_library)

    - [`java_grpc_library` documentation](https://grpc.io/docs/reference/java/generated-code.html) (look towards the

      bottom of the page for Bazel related documentation)

1.  Edit the `BUILD` file for `JavaLoggingClientLibrary.java`

    - [`java_library` documentation](https://docs.bazel.build/versions/master/be/java.html#java_library)

1.  Edit the `BUILD` file for `JavaLoggingClient.java`

    - [`java_binary` documentation](https://docs.bazel.build/versions/master/be/java.html#java_binary)

1.  `bazel run` the Java binary you wrote

1.  `bazel run` the Go binary from Section 2

1.  Send messages from the client to the server and view them on http://localhost:8081

## Section 4: Java client unit tests

1.  Edit the `BUILD` file for `JavaLoggingClientLibraryTest.java`

    - [`java_test` documentation](https://docs.bazel.build/versions/master/be/java.html#java_test)

     HintNames matter for tests. The java_test for this file should be named JavaLoggingClientLibraryTest

1.  Edit the `BUILD` file for `JavaLoggingClientTest.java`

1.  Run the tests using `bazel test`

## Section 5: Typescript web frontend

1.  Edit the `WORKSPACE` to uncomment the typescript relevant portions

1.  Edit the `BUILD` file for `logger.proto`

    - [`ts_proto_library` documentation](https://www.npmjs.com/package/@bazel/typescript#ts_proto_library)

1.  Edit the `BUILD` file for `app.ts`

    - [`ts_library` usage example](https://www.npmjs.com/package/@bazel/typescript#compiling-typescript-ts_library) and        [`ts_library` documentation](https://www.npmjs.com/package/@bazel/typescript#ts_library)

1.  Run the webserver using `bazel run`. It will print out a link which you can click on.

    If the link doesn't work, go to http://localhost:8080 instead

1.  Run the Go server and Java client from the previous steps. Send messages from the Java

    client to the Go server and see them appear on the web frontend

    

## Section 6: Integration test

1.  Edit the `BUILD` file for `integrationtest.sh`

    - [`sh_test` documentation](https://docs.bazel.build/versions/master/be/shell.html#sh_test)

1.  Run the test using `bazel test` and make sure that it passes

1.  Run the test using `bazel test  --runs_per_test=10` and make sure that it passes

     HintYou may need to modify the BUILD file again to make this work

## Section 7: Query

1.  https://docs.bazel.build/versions/master/query-how-to.html