Test code samples under CI

googleapis / python-spanner

Apache License 2.0

137 stars 88 forks source link

Closed larkee closed 8 months ago

larkee commented 5 years ago

The documentation hosted on googleapis.dev is out of date and the code examples throw errors. These are contained here and need to be updated.

tseaver commented 5 years ago

@larkee Ideally we would factor the samples out into modules that could be tested under CI. We have several patterns for this in other libraries:

language and speech use the sample-tester package.
bigquery_datatransfer, bigquery_storage, and datacatalog use py.test-style drivers for the samples session under nox.
bigquery, bigtable, and securitycenter use a py.test driver, but call the nox session snippets rather than samples.

larkee commented 4 years ago

Looked into this a couple weeks ago and have an idea of how to proceed. Will work on this next time I get some downtime.

harshachinta commented 9 months ago

@larkee Can you please give some context and additional information on this issue? AFAIK, all code samples in https://cloud.google.com/spanner/docs/getting-started/python and https://github.com/googleapis/python-spanner/tree/main/samples/samples are validated through a presubmit Samples - Python and should not be out of date.