Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Test code samples under CI #5

Closed
larkee opened this issue Nov 12, 2019 · 3 comments
Closed

Test code samples under CI #5

larkee opened this issue Nov 12, 2019 · 3 comments
Labels
api: spanner Issues related to the googleapis/python-spanner API. priority: p3 Desirable enhancement or fix. May not be included in next release. type: cleanup An internal cleanup or hygiene concern. type: docs Improvement to the documentation for an API.

Comments

@larkee
Copy link
Contributor

larkee commented Nov 12, 2019

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.
@larkee larkee self-assigned this Nov 12, 2019
@tseaver
Copy link
Contributor

tseaver commented Nov 12, 2019

@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.

@crwilcox crwilcox transferred this issue from googleapis/google-cloud-python Jan 31, 2020
@product-auto-label product-auto-label bot added the api: spanner Issues related to the googleapis/python-spanner API. label Jan 31, 2020
@yoshi-automation yoshi-automation added triage me I really want to be triaged. 🚨 This issue needs some love. labels Feb 3, 2020
@busunkim96 busunkim96 added type: docs Improvement to the documentation for an API. and removed 🚨 This issue needs some love. triage me I really want to be triaged. labels Feb 4, 2020
@larkee larkee added type: cleanup An internal cleanup or hygiene concern. priority: p2 Moderately-important priority. Fix may not be included in next release. labels Feb 5, 2020
@yoshi-automation yoshi-automation added 🚨 This issue needs some love. and removed 🚨 This issue needs some love. labels May 5, 2020
@larkee larkee changed the title Spanner: Out of date code examples Test code samples under CI May 13, 2020
@larkee larkee removed 🚨 This issue needs some love. type: cleanup An internal cleanup or hygiene concern. labels May 13, 2020
@yoshi-automation yoshi-automation added the 🚨 This issue needs some love. label May 13, 2020
@larkee
Copy link
Contributor Author

larkee commented Jun 19, 2020

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.

@larkee larkee removed the 🚨 This issue needs some love. label Jun 19, 2020
@yoshi-automation yoshi-automation added the 🚨 This issue needs some love. label Jun 19, 2020
@larkee larkee added type: cleanup An internal cleanup or hygiene concern. and removed 🚨 This issue needs some love. labels Jul 2, 2020
@yoshi-automation yoshi-automation added the 🚨 This issue needs some love. label Jul 2, 2020
@skuruppu skuruppu added priority: p3 Desirable enhancement or fix. May not be included in next release. and removed priority: p2 Moderately-important priority. Fix may not be included in next release. 🚨 This issue needs some love. labels Sep 3, 2020
@yoshi-automation yoshi-automation added 🚨 This issue needs some love. and removed 🚨 This issue needs some love. labels Mar 2, 2021
@yoshi-automation yoshi-automation added the 🚨 This issue needs some love. label Nov 3, 2021
@yoshi-automation yoshi-automation removed the 🚨 This issue needs some love. label Nov 8, 2021
@yoshi-automation yoshi-automation added 🚨 This issue needs some love. and removed 🚨 This issue needs some love. labels May 7, 2022
@larkee larkee removed their assignment Aug 4, 2022
@harshachinta
Copy link
Contributor

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
api: spanner Issues related to the googleapis/python-spanner API. priority: p3 Desirable enhancement or fix. May not be included in next release. type: cleanup An internal cleanup or hygiene concern. type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
6 participants
@tseaver @skuruppu @busunkim96 @larkee @yoshi-automation @harshachinta