chore: migrate to owl bot (#158)

This PR migrates from autosynth to owl bot. owl bot will save time for maintainers as it will automatically open PRs when there are updates in googleapis-gen without requiring maintainers to run synthtool to build the client from protos. Additionally, similar to autosynth, PRs will be automatically opened when there are template updates.

packages/google-cloud-python-speech/.github/.OwlBot.yaml

@@ -0,0 +1,26 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+docker:
+  image: gcr.io/repo-automation-bots/owlbot-python:latest
+
+deep-remove-regex:
+  - /owl-bot-staging
+
+deep-copy-regex:
+  - source: /google/cloud/speech/(v.*)/.*-py/(.*)
+    dest: /owl-bot-staging/$1/$2
+
+begin-after-commit-hash: 5b168da672b70ae9b5897b268b5e62f1c932a411
+

packages/google-cloud-python-speech/.pre-commit-config.yaml

@@ -26,6 +26,6 @@ repos:
     hooks:
     - id: black
 -   repo: https://gitlab.com/pycqa/flake8
-    rev: 3.9.0
+    rev: 3.9.1
     hooks:
     - id: flake8

packages/google-cloud-python-speech/CONTRIBUTING.rst

@@ -160,21 +160,7 @@ Running System Tests
   auth settings and change some configuration in your project to
   run all the tests.
 
-- System tests will be run against an actual project and
-  so you'll need to provide some environment variables to facilitate
-  authentication to your project:
-
-  - ``GOOGLE_APPLICATION_CREDENTIALS``: The path to a JSON key file;
-    Such a file can be downloaded directly from the developer's console by clicking
-    "Generate new JSON key". See private key
-    `docs <https://cloud.google.com/storage/docs/authentication#generating-a-private-key>`__
-    for more details.
-
-- Once you have downloaded your json keys, set the environment variable 
-  ``GOOGLE_APPLICATION_CREDENTIALS`` to the absolute path of the json file::
-
-   $ export GOOGLE_APPLICATION_CREDENTIALS="/Users/<your_username>/path/to/app_credentials.json"
-
+- System tests will be run against an actual project. You should use local credentials from gcloud when possible. See `Best practices for application authentication <https://cloud.google.com/docs/authentication/best-practices-applications#local_development_and_testing_with_the>`__. Some tests require a service account. For those tests see `Authenticating as a service account <https://cloud.google.com/docs/authentication/production>`__.
 
 *************
 Test Coverage

packages/google-cloud-python-speech/docs/_static/custom.css

@@ -1,9 +1,20 @@
 div#python2-eol {
 	border-color: red;
 	border-width: medium;
-} 
+}
 
 /* Ensure minimum width for 'Parameters' / 'Returns' column */
 dl.field-list > dt {
     min-width: 100px
 }
+
+/* Insert space between methods for readability */
+dl.method {
+	padding-top: 10px;
+	padding-bottom: 10px
+}
+
+/* Insert empty space between classes */
+dl.class {
+	padding-bottom: 50px
+}

packages/google-cloud-python-speech/google/cloud/speech_v1p1beta1/__init__.py

@@ -60,7 +60,6 @@ class SpeechClient(SpeechHelpers, SpeechClient):
 
 
 __all__ = (
-    "AdaptationClient",
     "CreateCustomClassRequest",
     "CreatePhraseSetRequest",
     "CustomClass",
@@ -83,6 +82,7 @@ class SpeechClient(SpeechHelpers, SpeechClient):
     "RecognizeResponse",
     "SpeakerDiarizationConfig",
     "SpeechAdaptation",
+    "SpeechClient",
     "SpeechContext",
     "SpeechRecognitionAlternative",
     "SpeechRecognitionResult",
@@ -94,5 +94,5 @@ class SpeechClient(SpeechHelpers, SpeechClient):
     "UpdateCustomClassRequest",
     "UpdatePhraseSetRequest",
     "WordInfo",
-    "SpeechClient",
+    "AdaptationClient",
 )

packages/google-cloud-python-speech/noxfile.py

@@ -62,16 +62,9 @@ def lint(session):
     session.run("flake8", "google", "tests")
 
 
-@nox.session(python="3.6")
+@nox.session(python=DEFAULT_PYTHON_VERSION)
 def blacken(session):
-    """Run black.
-
-    Format code to uniform standard.
-
-    This currently uses Python 3.6 due to the automated Kokoro run of synthtool.
-    That run uses an image that doesn't have 3.6 installed. Before updating this
-    check the state of the `gcp_ubuntu_config` we use for that Kokoro run.
-    """
+    """Run black. Format code to uniform standard."""
     session.install(BLACK_VERSION)
     session.run(
         "black", *BLACK_PATHS,
@@ -131,9 +124,6 @@ def system(session):
     # Check the value of `RUN_SYSTEM_TESTS` env var. It defaults to true.
     if os.environ.get("RUN_SYSTEM_TESTS", "true") == "false":
         session.skip("RUN_SYSTEM_TESTS is set to false, skipping")
-    # Sanity check: Only run tests if the environment variable is set.
-    if not os.environ.get("GOOGLE_APPLICATION_CREDENTIALS", ""):
-        session.skip("Credentials must be set via environment variable")
     # Install pyopenssl for mTLS testing.
     if os.environ.get("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") == "true":
         session.install("pyopenssl")

packages/google-cloud-python-speech/synth.py → packages/google-cloud-python-speech/owlbot.py

@@ -18,47 +18,36 @@
 from synthtool import gcp
 from synthtool.languages import python
 
-gapic = gcp.GAPICBazel()
 common = gcp.CommonTemplates()
-versions = ["v1p1beta1", "v1"]
 
+default_version = "v1"
 
-# ----------------------------------------------------------------------------
-# Generate speech GAPIC layer
-# ----------------------------------------------------------------------------
-for version in versions:
-    library = gapic.py_library(
-        service="speech",
-        version=version,
-        bazel_target=f"//google/cloud/speech/{version}:speech-{version}-py",
-        include_protos=True,
-    )
-
-    # Don't move over __init__.py, as we modify it to make the generated client
-    # use helpers.py.
-    s.move(library, excludes=["setup.py", "docs/index.rst", "README.rst"])
-
-
-# Add the manually written SpeechHelpers to v1 and v1p1beta1
-# See google/cloud/speech_v1/helpers.py for details
-count = s.replace(
-["google/cloud/speech_v1/__init__.py", "google/cloud/speech_v1p1beta1/__init__.py"],
-"""__all__ = \(""",
-"""from google.cloud.speech_v1.helpers import SpeechHelpers
+for library in s.get_staging_dirs(default_version):
+    # Add the manually written SpeechHelpers to v1 and v1p1beta1
+    # See google/cloud/speech_v1/helpers.py for details
+    count = s.replace(library / f"google/cloud/speech_{library.name}/__init__.py",
+                        """__all__ = \(""",
+                        """from google.cloud.speech_v1.helpers import SpeechHelpers
 
 class SpeechClient(SpeechHelpers, SpeechClient):
     __doc__ = SpeechClient.__doc__
 
 __all__ = (
-""",
-    )
+                        """,
+                    )
 
-# Import from speech_v1 to get the client with SpeechHelpers
-count = s.replace(
-"google/cloud/speech/__init__.py",
-"""from google\.cloud\.speech_v1\.services\.speech\.client import SpeechClient""",
-"""from google.cloud.speech_v1 import SpeechClient"""
-)
+    if library.name == "v1":
+        # Import from speech_v1 to get the client with SpeechHelpers
+        count = s.replace(library / "google/cloud/speech/__init__.py",
+            """from google\.cloud\.speech_v1\.services\.speech\.client import SpeechClient""",
+            """from google.cloud.speech_v1 import SpeechClient"""
+            )
+
+    # Don't move over __init__.py, as we modify it to make the generated client
+    # use helpers.py.
+    s.move(library, excludes=["setup.py", "docs/index.rst", "README.rst"])
+
+s.remove_staging_dirs()
 
 # ----------------------------------------------------------------------------
 # Add templated files

packages/google-cloud-python-speech/renovate.json

@@ -2,5 +2,8 @@
   "extends": [
     "config:base",  ":preserveSemverRanges"
   ],
-  "ignorePaths": [".pre-commit-config.yaml"]
+  "ignorePaths": [".pre-commit-config.yaml"],
+  "pip_requirements": {
+    "fileMatch": ["requirements-test.txt", "samples/[\\S/]*constraints.txt", "samples/[\\S/]*constraints-test.txt"]
+  }
 }

packages/google-cloud-python-speech/samples/microphone/noxfile.py

@@ -172,10 +172,16 @@ def blacken(session: nox.sessions.Session) -> None:
 def _session_tests(session: nox.sessions.Session, post_install: Callable = None) -> None:
     """Runs py.test for a particular project."""
     if os.path.exists("requirements.txt"):
-        session.install("-r", "requirements.txt")
+        if os.path.exists("constraints.txt"):
+            session.install("-r", "requirements.txt", "-c", "constraints.txt")
+        else:
+            session.install("-r", "requirements.txt")
 
     if os.path.exists("requirements-test.txt"):
-        session.install("-r", "requirements-test.txt")
+        if os.path.exists("constraints-test.txt"):
+            session.install("-r", "requirements-test.txt", "-c", "constraints-test.txt")
+        else:
+            session.install("-r", "requirements-test.txt")
 
     if INSTALL_LIBRARY_FROM_SOURCE:
         session.install("-e", _get_repo_root())

packages/google-cloud-python-speech/samples/snippets/noxfile.py

@@ -172,10 +172,16 @@ def blacken(session: nox.sessions.Session) -> None:
 def _session_tests(session: nox.sessions.Session, post_install: Callable = None) -> None:
     """Runs py.test for a particular project."""
     if os.path.exists("requirements.txt"):
-        session.install("-r", "requirements.txt")
+        if os.path.exists("constraints.txt"):
+            session.install("-r", "requirements.txt", "-c", "constraints.txt")
+        else:
+            session.install("-r", "requirements.txt")
 
     if os.path.exists("requirements-test.txt"):
-        session.install("-r", "requirements-test.txt")
+        if os.path.exists("constraints-test.txt"):
+            session.install("-r", "requirements-test.txt", "-c", "constraints-test.txt")
+        else:
+            session.install("-r", "requirements-test.txt")
 
     if INSTALL_LIBRARY_FROM_SOURCE:
         session.install("-e", _get_repo_root())