feat(generator): generate quickstart scaffold by coryan · Pull Request #7676 · googleapis/google-cloud-cpp

coryan · 2021-11-30T23:39:53Z

Modify the generator to also create a scaffold for the quickstart
program. Then I used the generator to create the scaffold for the
logging, pubsublite, secretmanager, and tasks libraries.

The generated code requires some editing, but these are fairly small.

These quickstarts are compiled in the cmake-install build, where we
can compile them in parallel. This was very useful, it found several
bugs in the generated CMake files.

Sorry for the gigantic PR. Most of it is generated code, I think you
should pay attention to:

Anything in generator/
google/cloud/*/doc/main.dox had some light editing
google/cloud/*/quickstart/README.md has some light editing
google/cloud/*/quickstart/quickstart.cc has some significant editing
Other files in google/cloud/*/quickstart/* are generated

This change is

Modify the generator to also create a scaffold for the quickstart program. Then I used the generator to create the scaffold for the `logging`, `pubsublite`, `secretmanager`, and `tasks` libraries. The generated code requires some editing, but these are fairly small. These quickstarts are compiled in the `cmake-install` build, where we can compile them in parallel. This was very useful, it found several bugs in the generated CMake files.

google-cloud-cpp-bot · 2021-11-30T23:42:00Z

Google Cloud Build Logs
For commit: 2252f138286788b0ed8544f3cd7951d10f74976e

Public Access Build Logs
Cloud Build Console (requires auth)
Kokoro Logs (requires auth)

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

codecov · 2021-11-30T23:49:44Z

Codecov Report

Merging #7676 (45e0846) into main (b92933b) will decrease coverage by 0.00%.
The diff coverage is 96.19%.

@@            Coverage Diff             @@
##             main    #7676      +/-   ##
==========================================
- Coverage   95.28%   95.28%   -0.01%     
==========================================
  Files        1254     1254              
  Lines      113312   113414     +102     
==========================================
+ Hits       107972   108067      +95     
- Misses       5340     5347       +7

Impacted Files	Coverage Δ
generator/internal/scaffold_generator.cc	`86.54% <91.83%> (+2.12%)`	⬆️
generator/internal/scaffold_generator_test.cc	`100.00% <100.00%> (ø)`
google/cloud/bigtable/async_read_stream_test.cc	`97.32% <0.00%> (-0.67%)`	⬇️
...le/cloud/storage/internal/curl_download_request.cc	`89.25% <0.00%> (-0.38%)`	⬇️
...ud/spanner/integration_tests/client_stress_test.cc	`86.18% <0.00%> (+0.65%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b92933b...45e0846. Read the comment docs.

google-cloud-cpp-bot · 2021-12-01T00:17:58Z

Google Cloud Build Logs
For commit: f185a12c570e98c9b493a55b4ee083dfd1806b12

Public Access Build Logs
Cloud Build Console (requires auth)
Kokoro Logs (requires auth)

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

google-cloud-cpp-bot · 2021-12-01T00:26:59Z

Google Cloud Build Logs
For commit: 17c0fd895709bb5585082205261fa6e421b78457

Public Access Build Logs
Cloud Build Console (requires auth)
Kokoro Logs (requires auth)

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

dbolduc

all nits. nothing functional.

dbolduc · 2021-12-01T15:06:25Z

+### Setting up your repo
+
+In order to use the $title$ C++ client library from your own code,
+you'll need to configure your build system how to fetch and compile the Cloud


s/how to/to/

dbolduc · 2021-12-01T15:06:45Z

+
+In order to use the $title$ C++ client library from your own code,
+you'll need to configure your build system how to fetch and compile the Cloud
+C++ client libraries. The Cloud C++ client libraries natively supports the


s/supports/support/

dbolduc · 2021-12-01T15:08:14Z

+
+- `GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc` turns on tracing for most gRPC
+  calls. The library injects an additional Stub decorator that prints each gRPC
+  request and response.  Unless you have configured you own logging backend,


s/you/your/

dbolduc · 2021-12-01T15:10:31Z

+  including whether messages will be output on multiple lines, or whether
+  string/bytes fields will be truncated.
+
+- `GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes` turns on logging in the library, basically


s/, basically/. Basically/

dbolduc · 2021-12-01T15:11:22Z

+
+- `GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes` turns on logging in the library, basically
+  the library always "logs" but the logging infrastructure has no backend to
+  actually print anything until the application sets a backend or they set this


s/they set/it sets/

dbolduc · 2021-12-01T15:12:42Z

+[`StatusOr<T>`][status-or-header] if an error is possible. This is an "outcome"
+type, when the operation is successful a `StatusOr<T>` converts to `true` in
+boolean context (and its `.ok()` member function returns `true`), the
+application can then use `operator->` or `operator*` to access then `T` value.


s/access then/access the/

dbolduc · 2021-12-01T15:13:18Z

+boolean context (and its `.ok()` member function returns `true`), the
+application can then use `operator->` or `operator*` to access then `T` value.
+When the operation fails a `StatusOr<T>` converts to `false` (and `.ok()`
+returns false). It is undefined behavior to use the value in this case.


s/false/false/

dbolduc · 2021-12-01T15:15:10Z

+[github-link]: https://github.com/googleapis/google-cloud-cpp 'GitHub Repository'
+<!-- The ugly %2E disables auto-linking in Doxygen -->
+[github-readme]:  https://github.com/googleapis/google-cloud-cpp/blob/main/google/cloud/$library$/README%2Emd
+[github-install]: https://github.com/googleapis/google-cloud-cpp/blob/main/doc/packagin%2Emd


s/packagin/packaging/ ?

dbolduc · 2021-12-01T15:23:37Z

+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
+# Fetch the Google Cloud C++ libraries.
+# NOTE: Update this version and SHA256 as needed.


hm. this is a little weird. but I think renovate-bot would update it.

Yeah, I figured that the benefit of trying to generate a perfect WORKSPACE file was not worth it since it will get updated anyway.

google-cloud-cpp-bot · 2021-12-01T16:26:58Z

Google Cloud Build Logs
For commit: 45e0846596522aad4ee698f040f609d2e75c06b3

Public Access Build Logs
Cloud Build Console (requires auth)
Kokoro Logs (requires auth)

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

coryan · 2021-12-01T16:42:23Z

PTAL

google-cla Bot added the cla: yes This human has signed the Contributor License Agreement. label Nov 30, 2021

Fix ignore lists

f185a12

Argh, missed this file

17c0fd8

coryan marked this pull request as ready for review December 1, 2021 00:43

coryan requested a review from a team December 1, 2021 00:43

dbolduc requested changes Dec 1, 2021

View reviewed changes

Address review comments

45e0846

devjgm approved these changes Dec 1, 2021

View reviewed changes

dbolduc approved these changes Dec 1, 2021

View reviewed changes

coryan merged commit fc6a1af into googleapis:main Dec 1, 2021

coryan deleted the feat-generator-improve-scaffold branch December 1, 2021 17:27

Conversation

coryan commented Nov 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

google-cloud-cpp-bot commented Nov 30, 2021

Uh oh!

codecov Bot commented Nov 30, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

google-cloud-cpp-bot commented Dec 1, 2021

Uh oh!

google-cloud-cpp-bot commented Dec 1, 2021

Uh oh!

dbolduc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

google-cloud-cpp-bot commented Dec 1, 2021

Uh oh!

coryan commented Dec 1, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

coryan commented Nov 30, 2021 •

edited

Loading

codecov Bot commented Nov 30, 2021 •

edited

Loading