From 3cf21dd76d18971290f09cfe88d413a3cef5ccfb Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 10 Apr 2025 17:52:09 +0000 Subject: [PATCH 1/5] chore(python): remove CONTRIBUTING.rst from templates Source-Link: https://github.com/googleapis/synthtool/commit/c96fb118e03c2b50d50fe17c1d0845479a0cfa9a Post-Processor: gcr.io/cloud-devrel-public-resources/owlbot-python:latest@sha256:710b70faff81151657d89db6e028c23a1051787598c8276bdd8eef25c92da8ab --- .github/.OwlBot.lock.yaml | 4 ++-- CONTRIBUTING.rst | 25 +++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml index c4e82889..8bc6405e 100644 --- a/.github/.OwlBot.lock.yaml +++ b/.github/.OwlBot.lock.yaml @@ -13,5 +13,5 @@ # limitations under the License. docker: image: gcr.io/cloud-devrel-public-resources/owlbot-python:latest - digest: sha256:023a21377a2a00008057f99f0118edadc30a19d1636a3fee47189ebec2f3921c -# created: 2025-03-31T16:51:40.130756953Z + digest: sha256:710b70faff81151657d89db6e028c23a1051787598c8276bdd8eef25c92da8ab +# created: 2025-04-10T17:48:54.829145676Z diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c59f8503..d209f0c3 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -157,6 +157,31 @@ Running System Tests - System tests will be run against an actual project. You should use local credentials from gcloud when possible. See `Best practices for application authentication `__. Some tests require a service account. For those tests see `Authenticating as a service account `__. +- You'll need to create composite + `indexes `__ + with the ``gcloud`` command line + `tool `__:: + + # Install the app (App Engine Command Line Interface) component. + $ gcloud components install app-engine-python + + # Authenticate the gcloud tool with your account. + $ GOOGLE_APPLICATION_CREDENTIALS="path/to/app_credentials.json" + $ gcloud auth activate-service-account > --key-file=${GOOGLE_APPLICATION_CREDENTIALS} + + # Create the indexes + $ gcloud datastore indexes create tests/system/index.yaml + +- You'll also need stored data in your dataset. To populate this data, run:: + + $ python tests/system/utils/populate_datastore.py + +- If you make a mistake during development (i.e. a failing test that + prevents clean-up) you can clear all system test data from your + datastore instance via:: + + $ python tests/system/utils/clear_datastore.py + - You'll need to create composite `indexes `__ with the ``gcloud`` command line From e5f0f2955369c1e4ead7c32b4eef4c5c283a3a07 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 10 Apr 2025 17:54:46 +0000 Subject: [PATCH 2/5] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- CONTRIBUTING.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d209f0c3..d6ee0f53 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -207,6 +207,31 @@ Running System Tests $ python tests/system/utils/clear_datastore.py +- You'll need to create composite + `indexes `__ + with the ``gcloud`` command line + `tool `__:: + + # Install the app (App Engine Command Line Interface) component. + $ gcloud components install app-engine-python + + # Authenticate the gcloud tool with your account. + $ GOOGLE_APPLICATION_CREDENTIALS="path/to/app_credentials.json" + $ gcloud auth activate-service-account > --key-file=${GOOGLE_APPLICATION_CREDENTIALS} + + # Create the indexes + $ gcloud datastore indexes create tests/system/index.yaml + +- You'll also need stored data in your dataset. To populate this data, run:: + + $ python tests/system/utils/populate_datastore.py + +- If you make a mistake during development (i.e. a failing test that + prevents clean-up) you can clear all system test data from your + datastore instance via:: + + $ python tests/system/utils/clear_datastore.py + ************* Test Coverage ************* From 4d3b439a9512b977e08ea8ccc55cdb3942868ec9 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 10 Apr 2025 17:56:46 +0000 Subject: [PATCH 3/5] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- CONTRIBUTING.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index d6ee0f53..5fe223f7 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -232,6 +232,31 @@ Running System Tests $ python tests/system/utils/clear_datastore.py +- You'll need to create composite + `indexes `__ + with the ``gcloud`` command line + `tool `__:: + + # Install the app (App Engine Command Line Interface) component. + $ gcloud components install app-engine-python + + # Authenticate the gcloud tool with your account. + $ GOOGLE_APPLICATION_CREDENTIALS="path/to/app_credentials.json" + $ gcloud auth activate-service-account > --key-file=${GOOGLE_APPLICATION_CREDENTIALS} + + # Create the indexes + $ gcloud datastore indexes create tests/system/index.yaml + +- You'll also need stored data in your dataset. To populate this data, run:: + + $ python tests/system/utils/populate_datastore.py + +- If you make a mistake during development (i.e. a failing test that + prevents clean-up) you can clear all system test data from your + datastore instance via:: + + $ python tests/system/utils/clear_datastore.py + ************* Test Coverage ************* From c107ab42d525c88dbde2e088adac56f1cc2277e1 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 10 Apr 2025 17:58:39 +0000 Subject: [PATCH 4/5] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- CONTRIBUTING.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 5fe223f7..b6e9deab 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -257,6 +257,31 @@ Running System Tests $ python tests/system/utils/clear_datastore.py +- You'll need to create composite + `indexes `__ + with the ``gcloud`` command line + `tool `__:: + + # Install the app (App Engine Command Line Interface) component. + $ gcloud components install app-engine-python + + # Authenticate the gcloud tool with your account. + $ GOOGLE_APPLICATION_CREDENTIALS="path/to/app_credentials.json" + $ gcloud auth activate-service-account > --key-file=${GOOGLE_APPLICATION_CREDENTIALS} + + # Create the indexes + $ gcloud datastore indexes create tests/system/index.yaml + +- You'll also need stored data in your dataset. To populate this data, run:: + + $ python tests/system/utils/populate_datastore.py + +- If you make a mistake during development (i.e. a failing test that + prevents clean-up) you can clear all system test data from your + datastore instance via:: + + $ python tests/system/utils/clear_datastore.py + ************* Test Coverage ************* From 200d08fbdc7e532583f05d8783ec36420bb3092d Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Thu, 10 Apr 2025 14:36:15 -0400 Subject: [PATCH 5/5] Remove replacement in owlbot.py --- CONTRIBUTING.rst | 100 ----------------------------------------------- owlbot.py | 42 -------------------- 2 files changed, 142 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index b6e9deab..c59f8503 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -157,106 +157,6 @@ Running System Tests - System tests will be run against an actual project. You should use local credentials from gcloud when possible. See `Best practices for application authentication `__. Some tests require a service account. For those tests see `Authenticating as a service account `__. -- You'll need to create composite - `indexes `__ - with the ``gcloud`` command line - `tool `__:: - - # Install the app (App Engine Command Line Interface) component. - $ gcloud components install app-engine-python - - # Authenticate the gcloud tool with your account. - $ GOOGLE_APPLICATION_CREDENTIALS="path/to/app_credentials.json" - $ gcloud auth activate-service-account > --key-file=${GOOGLE_APPLICATION_CREDENTIALS} - - # Create the indexes - $ gcloud datastore indexes create tests/system/index.yaml - -- You'll also need stored data in your dataset. To populate this data, run:: - - $ python tests/system/utils/populate_datastore.py - -- If you make a mistake during development (i.e. a failing test that - prevents clean-up) you can clear all system test data from your - datastore instance via:: - - $ python tests/system/utils/clear_datastore.py - -- You'll need to create composite - `indexes `__ - with the ``gcloud`` command line - `tool `__:: - - # Install the app (App Engine Command Line Interface) component. - $ gcloud components install app-engine-python - - # Authenticate the gcloud tool with your account. - $ GOOGLE_APPLICATION_CREDENTIALS="path/to/app_credentials.json" - $ gcloud auth activate-service-account > --key-file=${GOOGLE_APPLICATION_CREDENTIALS} - - # Create the indexes - $ gcloud datastore indexes create tests/system/index.yaml - -- You'll also need stored data in your dataset. To populate this data, run:: - - $ python tests/system/utils/populate_datastore.py - -- If you make a mistake during development (i.e. a failing test that - prevents clean-up) you can clear all system test data from your - datastore instance via:: - - $ python tests/system/utils/clear_datastore.py - -- You'll need to create composite - `indexes `__ - with the ``gcloud`` command line - `tool `__:: - - # Install the app (App Engine Command Line Interface) component. - $ gcloud components install app-engine-python - - # Authenticate the gcloud tool with your account. - $ GOOGLE_APPLICATION_CREDENTIALS="path/to/app_credentials.json" - $ gcloud auth activate-service-account > --key-file=${GOOGLE_APPLICATION_CREDENTIALS} - - # Create the indexes - $ gcloud datastore indexes create tests/system/index.yaml - -- You'll also need stored data in your dataset. To populate this data, run:: - - $ python tests/system/utils/populate_datastore.py - -- If you make a mistake during development (i.e. a failing test that - prevents clean-up) you can clear all system test data from your - datastore instance via:: - - $ python tests/system/utils/clear_datastore.py - -- You'll need to create composite - `indexes `__ - with the ``gcloud`` command line - `tool `__:: - - # Install the app (App Engine Command Line Interface) component. - $ gcloud components install app-engine-python - - # Authenticate the gcloud tool with your account. - $ GOOGLE_APPLICATION_CREDENTIALS="path/to/app_credentials.json" - $ gcloud auth activate-service-account > --key-file=${GOOGLE_APPLICATION_CREDENTIALS} - - # Create the indexes - $ gcloud datastore indexes create tests/system/index.yaml - -- You'll also need stored data in your dataset. To populate this data, run:: - - $ python tests/system/utils/populate_datastore.py - -- If you make a mistake during development (i.e. a failing test that - prevents clean-up) you can clear all system test data from your - datastore instance via:: - - $ python tests/system/utils/clear_datastore.py - - You'll need to create composite `indexes `__ with the ``gcloud`` command line diff --git a/owlbot.py b/owlbot.py index 9fcf0e15..cbb0f8ae 100644 --- a/owlbot.py +++ b/owlbot.py @@ -211,48 +211,6 @@ def docfx(session): r"Dict[str, str]", ) -# Add documentation about creating indexes and populating data for system -# tests. -assert 1 == s.replace( - "CONTRIBUTING.rst", - r""" -\*\*\*\*\*\*\*\*\*\*\*\*\* -Test Coverage -\*\*\*\*\*\*\*\*\*\*\*\*\* -""", - """ -- You'll need to create composite - `indexes `__ - with the ``gcloud`` command line - `tool `__:: - - # Install the app (App Engine Command Line Interface) component. - $ gcloud components install app-engine-python - - # Authenticate the gcloud tool with your account. - $ GOOGLE_APPLICATION_CREDENTIALS="path/to/app_credentials.json" - $ gcloud auth activate-service-account \ - > --key-file=${GOOGLE_APPLICATION_CREDENTIALS} - - # Create the indexes - $ gcloud datastore indexes create tests/system/index.yaml - -- You'll also need stored data in your dataset. To populate this data, run:: - - $ python tests/system/utils/populate_datastore.py - -- If you make a mistake during development (i.e. a failing test that - prevents clean-up) you can clear all system test data from your - datastore instance via:: - - $ python tests/system/utils/clear_datastore.py - -************* -Test Coverage -************* -""", -) - # add type checker nox session s.replace( "noxfile.py",