From b11175e2bbe68338abeb2a96630088800372e2f8 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 3 Feb 2022 00:39:36 +0000 Subject: [PATCH 1/2] chore: use gapic-generator-python 0.62.1 fix: restore 100% coverage for generated clients feat: adds REST server-streaming support fix: add special method parameters to set of reserved module names feat: expose extended operations annotations within generator fix: resolve DuplicateCredentialArgs error when using credentials_file committer: parthea PiperOrigin-RevId: 425964861 Source-Link: https://github.com/googleapis/googleapis/commit/84b1a5a4f6fb2d04905be58e586b8a7a4310a8cf Source-Link: https://github.com/googleapis/googleapis-gen/commit/4fb761bbd8506ac156f49bac5f18306aa8eb3aa8 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNGZiNzYxYmJkODUwNmFjMTU2ZjQ5YmFjNWYxODMwNmFhOGViM2FhOCJ9 --- owl-bot-staging/v2/.coveragerc | 17 + owl-bot-staging/v2/MANIFEST.in | 2 + owl-bot-staging/v2/README.rst | 49 + owl-bot-staging/v2/docs/conf.py | 376 ++++ .../v2/docs/debugger_v2/controller2.rst | 6 + .../v2/docs/debugger_v2/debugger2.rst | 6 + .../v2/docs/debugger_v2/services.rst | 7 + owl-bot-staging/v2/docs/debugger_v2/types.rst | 7 + owl-bot-staging/v2/docs/index.rst | 7 + .../v2/google/cloud/debugger/__init__.py | 71 + .../v2/google/cloud/debugger/py.typed | 2 + .../v2/google/cloud/debugger_v2/__init__.py | 72 + .../cloud/debugger_v2/gapic_metadata.json | 117 + .../v2/google/cloud/debugger_v2/py.typed | 2 + .../cloud/debugger_v2/services/__init__.py | 15 + .../services/controller2/__init__.py | 22 + .../services/controller2/async_client.py | 478 ++++ .../services/controller2/client.py | 651 ++++++ .../controller2/transports/__init__.py | 33 + .../services/controller2/transports/base.py | 188 ++ .../services/controller2/transports/grpc.py | 362 +++ .../controller2/transports/grpc_asyncio.py | 366 +++ .../services/debugger2/__init__.py | 22 + .../services/debugger2/async_client.py | 644 ++++++ .../debugger_v2/services/debugger2/client.py | 803 +++++++ .../services/debugger2/transports/__init__.py | 33 + .../services/debugger2/transports/base.py | 231 ++ .../services/debugger2/transports/grpc.py | 374 ++++ .../debugger2/transports/grpc_asyncio.py | 378 ++++ .../cloud/debugger_v2/types/__init__.py | 68 + .../cloud/debugger_v2/types/controller.py | 172 ++ .../v2/google/cloud/debugger_v2/types/data.py | 636 ++++++ .../cloud/debugger_v2/types/debugger.py | 311 +++ owl-bot-staging/v2/mypy.ini | 3 + owl-bot-staging/v2/noxfile.py | 132 ++ .../v2/scripts/fixup_debugger_v2_keywords.py | 183 ++ owl-bot-staging/v2/setup.py | 54 + owl-bot-staging/v2/tests/__init__.py | 16 + owl-bot-staging/v2/tests/unit/__init__.py | 16 + .../v2/tests/unit/gapic/__init__.py | 16 + .../tests/unit/gapic/debugger_v2/__init__.py | 16 + .../gapic/debugger_v2/test_controller2.py | 1580 +++++++++++++ .../unit/gapic/debugger_v2/test_debugger2.py | 1981 +++++++++++++++++ 43 files changed, 10525 insertions(+) create mode 100644 owl-bot-staging/v2/.coveragerc create mode 100644 owl-bot-staging/v2/MANIFEST.in create mode 100644 owl-bot-staging/v2/README.rst create mode 100644 owl-bot-staging/v2/docs/conf.py create mode 100644 owl-bot-staging/v2/docs/debugger_v2/controller2.rst create mode 100644 owl-bot-staging/v2/docs/debugger_v2/debugger2.rst create mode 100644 owl-bot-staging/v2/docs/debugger_v2/services.rst create mode 100644 owl-bot-staging/v2/docs/debugger_v2/types.rst create mode 100644 owl-bot-staging/v2/docs/index.rst create mode 100644 owl-bot-staging/v2/google/cloud/debugger/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger/py.typed create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/py.typed create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py create mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py create mode 100644 owl-bot-staging/v2/mypy.ini create mode 100644 owl-bot-staging/v2/noxfile.py create mode 100644 owl-bot-staging/v2/scripts/fixup_debugger_v2_keywords.py create mode 100644 owl-bot-staging/v2/setup.py create mode 100644 owl-bot-staging/v2/tests/__init__.py create mode 100644 owl-bot-staging/v2/tests/unit/__init__.py create mode 100644 owl-bot-staging/v2/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py create mode 100644 owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py create mode 100644 owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py diff --git a/owl-bot-staging/v2/.coveragerc b/owl-bot-staging/v2/.coveragerc new file mode 100644 index 0000000..d63da53 --- /dev/null +++ b/owl-bot-staging/v2/.coveragerc @@ -0,0 +1,17 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/debugger/__init__.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ + # Ignore pkg_resources exceptions. + # This is added at the module level as a safeguard for if someone + # generates the code and tries to run it without pip installing. This + # makes it virtually impossible to test properly. + except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v2/MANIFEST.in b/owl-bot-staging/v2/MANIFEST.in new file mode 100644 index 0000000..f82c9a7 --- /dev/null +++ b/owl-bot-staging/v2/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/debugger *.py +recursive-include google/cloud/debugger_v2 *.py diff --git a/owl-bot-staging/v2/README.rst b/owl-bot-staging/v2/README.rst new file mode 100644 index 0000000..e042ba5 --- /dev/null +++ b/owl-bot-staging/v2/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Debugger API +================================================= + +Quick Start +----------- + +In order to use this library, you first need to go through the following steps: + +1. `Select or create a Cloud Platform project.`_ +2. `Enable billing for your project.`_ +3. Enable the Google Cloud Debugger API. +4. `Setup Authentication.`_ + +.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project +.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project +.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html + +Installation +~~~~~~~~~~~~ + +Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to +create isolated Python environments. The basic problem it addresses is one of +dependencies and versions, and indirectly permissions. + +With `virtualenv`_, it's possible to install this library without needing system +install permissions, and without clashing with the installed system +dependencies. + +.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ + + +Mac/Linux +^^^^^^^^^ + +.. code-block:: console + + python3 -m venv + source /bin/activate + /bin/pip install /path/to/library + + +Windows +^^^^^^^ + +.. code-block:: console + + python3 -m venv + \Scripts\activate + \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v2/docs/conf.py b/owl-bot-staging/v2/docs/conf.py new file mode 100644 index 0000000..bfac8d2 --- /dev/null +++ b/owl-bot-staging/v2/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +# +# google-cloud-debugger-client documentation build configuration file +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import shlex + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath("..")) + +__version__ = "0.1.0" + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +needs_sphinx = "4.0.1" + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "sphinx.ext.coverage", + "sphinx.ext.napoleon", + "sphinx.ext.todo", + "sphinx.ext.viewcode", +] + +# autodoc/autosummary flags +autoclass_content = "both" +autodoc_default_flags = ["members"] +autosummary_generate = True + + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# Allow markdown includes (so releases.md can include CHANGLEOG.md) +# http://www.sphinx-doc.org/en/master/markdown.html +source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +source_suffix = [".rst", ".md"] + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The root toctree document. +root_doc = "index" + +# General information about the project. +project = u"google-cloud-debugger-client" +copyright = u"2020, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Client Libraries for Python", + "github_user": "googleapis", + "github_repo": "google-cloud-python", + "github_banner": True, + "font_family": "'Roboto', Georgia, sans", + "head_font_family": "'Roboto', Georgia, serif", + "code_font_family": "'Roboto Mono', 'Consolas', monospace", +} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +# html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +# html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +# html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = "google-cloud-debugger-client-doc" + +# -- Options for warnings ------------------------------------------------------ + + +suppress_warnings = [ + # Temporarily suppress this to avoid "more than one target found for + # cross-reference" warning, which are intractable for us to avoid while in + # a mono-repo. + # See https://github.com/sphinx-doc/sphinx/blob + # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 + "ref.python" +] + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # 'preamble': '', + # Latex figure (float) alignment + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ( + root_doc, + "google-cloud-debugger-client.tex", + u"google-cloud-debugger-client Documentation", + author, + "manual", + ) +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ( + root_doc, + "google-cloud-debugger-client", + u"Google Cloud Debugger Documentation", + [author], + 1, + ) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + root_doc, + "google-cloud-debugger-client", + u"google-cloud-debugger-client Documentation", + author, + "google-cloud-debugger-client", + "GAPIC library for Google Cloud Debugger API", + "APIs", + ) +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "python": ("http://python.readthedocs.org/en/latest/", None), + "gax": ("https://gax-python.readthedocs.org/en/latest/", None), + "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), + "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), + "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), + "grpc": ("https://grpc.io/grpc/python/", None), + "requests": ("http://requests.kennethreitz.org/en/stable/", None), + "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), + "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), +} + + +# Napoleon settings +napoleon_google_docstring = True +napoleon_numpy_docstring = True +napoleon_include_private_with_doc = False +napoleon_include_special_with_doc = True +napoleon_use_admonition_for_examples = False +napoleon_use_admonition_for_notes = False +napoleon_use_admonition_for_references = False +napoleon_use_ivar = False +napoleon_use_param = True +napoleon_use_rtype = True diff --git a/owl-bot-staging/v2/docs/debugger_v2/controller2.rst b/owl-bot-staging/v2/docs/debugger_v2/controller2.rst new file mode 100644 index 0000000..1fbfbd1 --- /dev/null +++ b/owl-bot-staging/v2/docs/debugger_v2/controller2.rst @@ -0,0 +1,6 @@ +Controller2 +----------------------------- + +.. automodule:: google.cloud.debugger_v2.services.controller2 + :members: + :inherited-members: diff --git a/owl-bot-staging/v2/docs/debugger_v2/debugger2.rst b/owl-bot-staging/v2/docs/debugger_v2/debugger2.rst new file mode 100644 index 0000000..f99c7c3 --- /dev/null +++ b/owl-bot-staging/v2/docs/debugger_v2/debugger2.rst @@ -0,0 +1,6 @@ +Debugger2 +--------------------------- + +.. automodule:: google.cloud.debugger_v2.services.debugger2 + :members: + :inherited-members: diff --git a/owl-bot-staging/v2/docs/debugger_v2/services.rst b/owl-bot-staging/v2/docs/debugger_v2/services.rst new file mode 100644 index 0000000..b462437 --- /dev/null +++ b/owl-bot-staging/v2/docs/debugger_v2/services.rst @@ -0,0 +1,7 @@ +Services for Google Cloud Debugger v2 API +========================================= +.. toctree:: + :maxdepth: 2 + + controller2 + debugger2 diff --git a/owl-bot-staging/v2/docs/debugger_v2/types.rst b/owl-bot-staging/v2/docs/debugger_v2/types.rst new file mode 100644 index 0000000..b649b71 --- /dev/null +++ b/owl-bot-staging/v2/docs/debugger_v2/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Debugger v2 API +====================================== + +.. automodule:: google.cloud.debugger_v2.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v2/docs/index.rst b/owl-bot-staging/v2/docs/index.rst new file mode 100644 index 0000000..004b591 --- /dev/null +++ b/owl-bot-staging/v2/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + debugger_v2/services + debugger_v2/types diff --git a/owl-bot-staging/v2/google/cloud/debugger/__init__.py b/owl-bot-staging/v2/google/cloud/debugger/__init__.py new file mode 100644 index 0000000..f9522f1 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger/__init__.py @@ -0,0 +1,71 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# + +from google.cloud.debugger_v2.services.controller2.client import Controller2Client +from google.cloud.debugger_v2.services.controller2.async_client import Controller2AsyncClient +from google.cloud.debugger_v2.services.debugger2.client import Debugger2Client +from google.cloud.debugger_v2.services.debugger2.async_client import Debugger2AsyncClient + +from google.cloud.debugger_v2.types.controller import ListActiveBreakpointsRequest +from google.cloud.debugger_v2.types.controller import ListActiveBreakpointsResponse +from google.cloud.debugger_v2.types.controller import RegisterDebuggeeRequest +from google.cloud.debugger_v2.types.controller import RegisterDebuggeeResponse +from google.cloud.debugger_v2.types.controller import UpdateActiveBreakpointRequest +from google.cloud.debugger_v2.types.controller import UpdateActiveBreakpointResponse +from google.cloud.debugger_v2.types.data import Breakpoint +from google.cloud.debugger_v2.types.data import Debuggee +from google.cloud.debugger_v2.types.data import FormatMessage +from google.cloud.debugger_v2.types.data import SourceLocation +from google.cloud.debugger_v2.types.data import StackFrame +from google.cloud.debugger_v2.types.data import StatusMessage +from google.cloud.debugger_v2.types.data import Variable +from google.cloud.debugger_v2.types.debugger import DeleteBreakpointRequest +from google.cloud.debugger_v2.types.debugger import GetBreakpointRequest +from google.cloud.debugger_v2.types.debugger import GetBreakpointResponse +from google.cloud.debugger_v2.types.debugger import ListBreakpointsRequest +from google.cloud.debugger_v2.types.debugger import ListBreakpointsResponse +from google.cloud.debugger_v2.types.debugger import ListDebuggeesRequest +from google.cloud.debugger_v2.types.debugger import ListDebuggeesResponse +from google.cloud.debugger_v2.types.debugger import SetBreakpointRequest +from google.cloud.debugger_v2.types.debugger import SetBreakpointResponse + +__all__ = ('Controller2Client', + 'Controller2AsyncClient', + 'Debugger2Client', + 'Debugger2AsyncClient', + 'ListActiveBreakpointsRequest', + 'ListActiveBreakpointsResponse', + 'RegisterDebuggeeRequest', + 'RegisterDebuggeeResponse', + 'UpdateActiveBreakpointRequest', + 'UpdateActiveBreakpointResponse', + 'Breakpoint', + 'Debuggee', + 'FormatMessage', + 'SourceLocation', + 'StackFrame', + 'StatusMessage', + 'Variable', + 'DeleteBreakpointRequest', + 'GetBreakpointRequest', + 'GetBreakpointResponse', + 'ListBreakpointsRequest', + 'ListBreakpointsResponse', + 'ListDebuggeesRequest', + 'ListDebuggeesResponse', + 'SetBreakpointRequest', + 'SetBreakpointResponse', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger/py.typed b/owl-bot-staging/v2/google/cloud/debugger/py.typed new file mode 100644 index 0000000..a6f27ff --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-debugger-client package uses inline types. diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py new file mode 100644 index 0000000..6bea361 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py @@ -0,0 +1,72 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# + +from .services.controller2 import Controller2Client +from .services.controller2 import Controller2AsyncClient +from .services.debugger2 import Debugger2Client +from .services.debugger2 import Debugger2AsyncClient + +from .types.controller import ListActiveBreakpointsRequest +from .types.controller import ListActiveBreakpointsResponse +from .types.controller import RegisterDebuggeeRequest +from .types.controller import RegisterDebuggeeResponse +from .types.controller import UpdateActiveBreakpointRequest +from .types.controller import UpdateActiveBreakpointResponse +from .types.data import Breakpoint +from .types.data import Debuggee +from .types.data import FormatMessage +from .types.data import SourceLocation +from .types.data import StackFrame +from .types.data import StatusMessage +from .types.data import Variable +from .types.debugger import DeleteBreakpointRequest +from .types.debugger import GetBreakpointRequest +from .types.debugger import GetBreakpointResponse +from .types.debugger import ListBreakpointsRequest +from .types.debugger import ListBreakpointsResponse +from .types.debugger import ListDebuggeesRequest +from .types.debugger import ListDebuggeesResponse +from .types.debugger import SetBreakpointRequest +from .types.debugger import SetBreakpointResponse + +__all__ = ( + 'Controller2AsyncClient', + 'Debugger2AsyncClient', +'Breakpoint', +'Controller2Client', +'Debuggee', +'Debugger2Client', +'DeleteBreakpointRequest', +'FormatMessage', +'GetBreakpointRequest', +'GetBreakpointResponse', +'ListActiveBreakpointsRequest', +'ListActiveBreakpointsResponse', +'ListBreakpointsRequest', +'ListBreakpointsResponse', +'ListDebuggeesRequest', +'ListDebuggeesResponse', +'RegisterDebuggeeRequest', +'RegisterDebuggeeResponse', +'SetBreakpointRequest', +'SetBreakpointResponse', +'SourceLocation', +'StackFrame', +'StatusMessage', +'UpdateActiveBreakpointRequest', +'UpdateActiveBreakpointResponse', +'Variable', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json new file mode 100644 index 0000000..fce739c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json @@ -0,0 +1,117 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.debugger_v2", + "protoPackage": "google.devtools.clouddebugger.v2", + "schema": "1.0", + "services": { + "Controller2": { + "clients": { + "grpc": { + "libraryClient": "Controller2Client", + "rpcs": { + "ListActiveBreakpoints": { + "methods": [ + "list_active_breakpoints" + ] + }, + "RegisterDebuggee": { + "methods": [ + "register_debuggee" + ] + }, + "UpdateActiveBreakpoint": { + "methods": [ + "update_active_breakpoint" + ] + } + } + }, + "grpc-async": { + "libraryClient": "Controller2AsyncClient", + "rpcs": { + "ListActiveBreakpoints": { + "methods": [ + "list_active_breakpoints" + ] + }, + "RegisterDebuggee": { + "methods": [ + "register_debuggee" + ] + }, + "UpdateActiveBreakpoint": { + "methods": [ + "update_active_breakpoint" + ] + } + } + } + } + }, + "Debugger2": { + "clients": { + "grpc": { + "libraryClient": "Debugger2Client", + "rpcs": { + "DeleteBreakpoint": { + "methods": [ + "delete_breakpoint" + ] + }, + "GetBreakpoint": { + "methods": [ + "get_breakpoint" + ] + }, + "ListBreakpoints": { + "methods": [ + "list_breakpoints" + ] + }, + "ListDebuggees": { + "methods": [ + "list_debuggees" + ] + }, + "SetBreakpoint": { + "methods": [ + "set_breakpoint" + ] + } + } + }, + "grpc-async": { + "libraryClient": "Debugger2AsyncClient", + "rpcs": { + "DeleteBreakpoint": { + "methods": [ + "delete_breakpoint" + ] + }, + "GetBreakpoint": { + "methods": [ + "get_breakpoint" + ] + }, + "ListBreakpoints": { + "methods": [ + "list_breakpoints" + ] + }, + "ListDebuggees": { + "methods": [ + "list_debuggees" + ] + }, + "SetBreakpoint": { + "methods": [ + "set_breakpoint" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/py.typed b/owl-bot-staging/v2/google/cloud/debugger_v2/py.typed new file mode 100644 index 0000000..a6f27ff --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-debugger-client package uses inline types. diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py new file mode 100644 index 0000000..4de6597 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py new file mode 100644 index 0000000..c59a888 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +from .client import Controller2Client +from .async_client import Controller2AsyncClient + +__all__ = ( + 'Controller2Client', + 'Controller2AsyncClient', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py new file mode 100644 index 0000000..23e4b1c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py @@ -0,0 +1,478 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.debugger_v2.types import controller +from google.cloud.debugger_v2.types import data +from .transports.base import Controller2Transport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import Controller2GrpcAsyncIOTransport +from .client import Controller2Client + + +class Controller2AsyncClient: + """The Controller service provides the API for orchestrating a + collection of debugger agents to perform debugging tasks. These + agents are each attached to a process of an application which may + include one or more replicas. + + The debugger agents register with the Controller to identify the + application being debugged, the Debuggee. All agents that register + with the same data, represent the same Debuggee, and are assigned + the same ``debuggee_id``. + + The debugger agents call the Controller to retrieve the list of + active Breakpoints. Agents with the same ``debuggee_id`` get the + same breakpoints list. An agent that can fulfill the breakpoint + request updates the Controller with the breakpoint result. The + controller selects the first result received and discards the rest + of the results. Agents that poll again for active breakpoints will + no longer have the completed breakpoint in the list and should + remove that breakpoint from their attached process. + + The Controller service does not provide a way to retrieve the + results of a completed breakpoint. This functionality is available + using the Debugger service. + """ + + _client: Controller2Client + + DEFAULT_ENDPOINT = Controller2Client.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = Controller2Client.DEFAULT_MTLS_ENDPOINT + + common_billing_account_path = staticmethod(Controller2Client.common_billing_account_path) + parse_common_billing_account_path = staticmethod(Controller2Client.parse_common_billing_account_path) + common_folder_path = staticmethod(Controller2Client.common_folder_path) + parse_common_folder_path = staticmethod(Controller2Client.parse_common_folder_path) + common_organization_path = staticmethod(Controller2Client.common_organization_path) + parse_common_organization_path = staticmethod(Controller2Client.parse_common_organization_path) + common_project_path = staticmethod(Controller2Client.common_project_path) + parse_common_project_path = staticmethod(Controller2Client.parse_common_project_path) + common_location_path = staticmethod(Controller2Client.common_location_path) + parse_common_location_path = staticmethod(Controller2Client.parse_common_location_path) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + Controller2AsyncClient: The constructed client. + """ + return Controller2Client.from_service_account_info.__func__(Controller2AsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + Controller2AsyncClient: The constructed client. + """ + return Controller2Client.from_service_account_file.__func__(Controller2AsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variabel is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return Controller2Client.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> Controller2Transport: + """Returns the transport used by the client instance. + + Returns: + Controller2Transport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(Controller2Client).get_transport_class, type(Controller2Client)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, Controller2Transport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the controller2 client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, ~.Controller2Transport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (ClientOptions): Custom options for the client. It + won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = Controller2Client( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def register_debuggee(self, + request: Union[controller.RegisterDebuggeeRequest, dict] = None, + *, + debuggee: data.Debuggee = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> controller.RegisterDebuggeeResponse: + r"""Registers the debuggee with the controller service. + + All agents attached to the same application must call this + method with exactly the same request content to get back the + same stable ``debuggee_id``. Agents should call this method + again whenever ``google.rpc.Code.NOT_FOUND`` is returned from + any controller method. + + This protocol allows the controller service to disable + debuggees, recover from data loss, or change the ``debuggee_id`` + format. Agents must handle ``debuggee_id`` value changing upon + re-registration. + + Args: + request (Union[google.cloud.debugger_v2.types.RegisterDebuggeeRequest, dict]): + The request object. Request to register a debuggee. + debuggee (:class:`google.cloud.debugger_v2.types.Debuggee`): + Required. Debuggee information to register. The fields + ``project``, ``uniquifier``, ``description`` and + ``agent_version`` of the debuggee must be set. + + This corresponds to the ``debuggee`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.RegisterDebuggeeResponse: + Response for registering a debuggee. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = controller.RegisterDebuggeeRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee is not None: + request.debuggee = debuggee + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.register_debuggee, + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_active_breakpoints(self, + request: Union[controller.ListActiveBreakpointsRequest, dict] = None, + *, + debuggee_id: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> controller.ListActiveBreakpointsResponse: + r"""Returns the list of all active breakpoints for the debuggee. + + The breakpoint specification (``location``, ``condition``, and + ``expressions`` fields) is semantically immutable, although the + field values may change. For example, an agent may update the + location line number to reflect the actual line where the + breakpoint was set, but this doesn't change the breakpoint + semantics. + + This means that an agent does not need to check if a breakpoint + has changed when it encounters the same breakpoint on a + successive call. Moreover, an agent should remember the + breakpoints that are completed until the controller removes them + from the active list to avoid setting those breakpoints again. + + Args: + request (Union[google.cloud.debugger_v2.types.ListActiveBreakpointsRequest, dict]): + The request object. Request to list active breakpoints. + debuggee_id (:class:`str`): + Required. Identifies the debuggee. + This corresponds to the ``debuggee_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.ListActiveBreakpointsResponse: + Response for listing active + breakpoints. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee_id]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = controller.ListActiveBreakpointsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee_id is not None: + request.debuggee_id = debuggee_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_active_breakpoints, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=600.0, + ), + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_active_breakpoint(self, + request: Union[controller.UpdateActiveBreakpointRequest, dict] = None, + *, + debuggee_id: str = None, + breakpoint_: data.Breakpoint = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> controller.UpdateActiveBreakpointResponse: + r"""Updates the breakpoint state or mutable fields. The entire + Breakpoint message must be sent back to the controller service. + + Updates to active breakpoint fields are only allowed if the new + value does not change the breakpoint specification. Updates to + the ``location``, ``condition`` and ``expressions`` fields + should not alter the breakpoint semantics. These may only make + changes such as canonicalizing a value or snapping the location + to the correct line of code. + + Args: + request (Union[google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest, dict]): + The request object. Request to update an active + breakpoint. + debuggee_id (:class:`str`): + Required. Identifies the debuggee + being debugged. + + This corresponds to the ``debuggee_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + breakpoint_ (:class:`google.cloud.debugger_v2.types.Breakpoint`): + Required. Updated breakpoint information. The field + ``id`` must be set. The agent must echo all Breakpoint + specification fields in the update. + + This corresponds to the ``breakpoint_`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse: + Response for updating an active + breakpoint. The message is defined to + allow future extensions. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee_id, breakpoint_]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = controller.UpdateActiveBreakpointRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee_id is not None: + request.debuggee_id = debuggee_id + if breakpoint_ is not None: + request.breakpoint_ = breakpoint_ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.update_active_breakpoint, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=600.0, + ), + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-debugger-client", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "Controller2AsyncClient", +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py new file mode 100644 index 0000000..9fe1ecd --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py @@ -0,0 +1,651 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.debugger_v2.types import controller +from google.cloud.debugger_v2.types import data +from .transports.base import Controller2Transport, DEFAULT_CLIENT_INFO +from .transports.grpc import Controller2GrpcTransport +from .transports.grpc_asyncio import Controller2GrpcAsyncIOTransport + + +class Controller2ClientMeta(type): + """Metaclass for the Controller2 client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + _transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] + _transport_registry["grpc"] = Controller2GrpcTransport + _transport_registry["grpc_asyncio"] = Controller2GrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[Controller2Transport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class Controller2Client(metaclass=Controller2ClientMeta): + """The Controller service provides the API for orchestrating a + collection of debugger agents to perform debugging tasks. These + agents are each attached to a process of an application which may + include one or more replicas. + + The debugger agents register with the Controller to identify the + application being debugged, the Debuggee. All agents that register + with the same data, represent the same Debuggee, and are assigned + the same ``debuggee_id``. + + The debugger agents call the Controller to retrieve the list of + active Breakpoints. Agents with the same ``debuggee_id`` get the + same breakpoints list. An agent that can fulfill the breakpoint + request updates the Controller with the breakpoint result. The + controller selects the first result received and discards the rest + of the results. Agents that poll again for active breakpoints will + no longer have the completed breakpoint in the list and should + remove that breakpoint from their attached process. + + The Controller service does not provide a way to retrieve the + results of a completed breakpoint. This functionality is available + using the Debugger service. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "clouddebugger.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + Controller2Client: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + Controller2Client: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file( + filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> Controller2Transport: + """Returns the transport used by the client instance. + + Returns: + Controller2Transport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variabel is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, Controller2Transport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the controller2 client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, Controller2Transport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, Controller2Transport): + # transport is a Controller2Transport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + ) + + def register_debuggee(self, + request: Union[controller.RegisterDebuggeeRequest, dict] = None, + *, + debuggee: data.Debuggee = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> controller.RegisterDebuggeeResponse: + r"""Registers the debuggee with the controller service. + + All agents attached to the same application must call this + method with exactly the same request content to get back the + same stable ``debuggee_id``. Agents should call this method + again whenever ``google.rpc.Code.NOT_FOUND`` is returned from + any controller method. + + This protocol allows the controller service to disable + debuggees, recover from data loss, or change the ``debuggee_id`` + format. Agents must handle ``debuggee_id`` value changing upon + re-registration. + + Args: + request (Union[google.cloud.debugger_v2.types.RegisterDebuggeeRequest, dict]): + The request object. Request to register a debuggee. + debuggee (google.cloud.debugger_v2.types.Debuggee): + Required. Debuggee information to register. The fields + ``project``, ``uniquifier``, ``description`` and + ``agent_version`` of the debuggee must be set. + + This corresponds to the ``debuggee`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.RegisterDebuggeeResponse: + Response for registering a debuggee. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a controller.RegisterDebuggeeRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, controller.RegisterDebuggeeRequest): + request = controller.RegisterDebuggeeRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee is not None: + request.debuggee = debuggee + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.register_debuggee] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_active_breakpoints(self, + request: Union[controller.ListActiveBreakpointsRequest, dict] = None, + *, + debuggee_id: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> controller.ListActiveBreakpointsResponse: + r"""Returns the list of all active breakpoints for the debuggee. + + The breakpoint specification (``location``, ``condition``, and + ``expressions`` fields) is semantically immutable, although the + field values may change. For example, an agent may update the + location line number to reflect the actual line where the + breakpoint was set, but this doesn't change the breakpoint + semantics. + + This means that an agent does not need to check if a breakpoint + has changed when it encounters the same breakpoint on a + successive call. Moreover, an agent should remember the + breakpoints that are completed until the controller removes them + from the active list to avoid setting those breakpoints again. + + Args: + request (Union[google.cloud.debugger_v2.types.ListActiveBreakpointsRequest, dict]): + The request object. Request to list active breakpoints. + debuggee_id (str): + Required. Identifies the debuggee. + This corresponds to the ``debuggee_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.ListActiveBreakpointsResponse: + Response for listing active + breakpoints. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee_id]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a controller.ListActiveBreakpointsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, controller.ListActiveBreakpointsRequest): + request = controller.ListActiveBreakpointsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee_id is not None: + request.debuggee_id = debuggee_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_active_breakpoints] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_active_breakpoint(self, + request: Union[controller.UpdateActiveBreakpointRequest, dict] = None, + *, + debuggee_id: str = None, + breakpoint_: data.Breakpoint = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> controller.UpdateActiveBreakpointResponse: + r"""Updates the breakpoint state or mutable fields. The entire + Breakpoint message must be sent back to the controller service. + + Updates to active breakpoint fields are only allowed if the new + value does not change the breakpoint specification. Updates to + the ``location``, ``condition`` and ``expressions`` fields + should not alter the breakpoint semantics. These may only make + changes such as canonicalizing a value or snapping the location + to the correct line of code. + + Args: + request (Union[google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest, dict]): + The request object. Request to update an active + breakpoint. + debuggee_id (str): + Required. Identifies the debuggee + being debugged. + + This corresponds to the ``debuggee_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + breakpoint_ (google.cloud.debugger_v2.types.Breakpoint): + Required. Updated breakpoint information. The field + ``id`` must be set. The agent must echo all Breakpoint + specification fields in the update. + + This corresponds to the ``breakpoint_`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse: + Response for updating an active + breakpoint. The message is defined to + allow future extensions. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee_id, breakpoint_]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a controller.UpdateActiveBreakpointRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, controller.UpdateActiveBreakpointRequest): + request = controller.UpdateActiveBreakpointRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee_id is not None: + request.debuggee_id = debuggee_id + if breakpoint_ is not None: + request.breakpoint_ = breakpoint_ + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_active_breakpoint] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self): + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-debugger-client", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "Controller2Client", +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py new file mode 100644 index 0000000..d4601b2 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import Controller2Transport +from .grpc import Controller2GrpcTransport +from .grpc_asyncio import Controller2GrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] +_transport_registry['grpc'] = Controller2GrpcTransport +_transport_registry['grpc_asyncio'] = Controller2GrpcAsyncIOTransport + +__all__ = ( + 'Controller2Transport', + 'Controller2GrpcTransport', + 'Controller2GrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py new file mode 100644 index 0000000..d435289 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py @@ -0,0 +1,188 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import pkg_resources + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.debugger_v2.types import controller + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-debugger-client', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +class Controller2Transport(abc.ABC): + """Abstract transport class for Controller2.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/cloud_debugger', + ) + + DEFAULT_HOST: str = 'clouddebugger.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.register_debuggee: gapic_v1.method.wrap_method( + self.register_debuggee, + default_timeout=600.0, + client_info=client_info, + ), + self.list_active_breakpoints: gapic_v1.method.wrap_method( + self.list_active_breakpoints, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=600.0, + ), + default_timeout=600.0, + client_info=client_info, + ), + self.update_active_breakpoint: gapic_v1.method.wrap_method( + self.update_active_breakpoint, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=600.0, + ), + default_timeout=600.0, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def register_debuggee(self) -> Callable[ + [controller.RegisterDebuggeeRequest], + Union[ + controller.RegisterDebuggeeResponse, + Awaitable[controller.RegisterDebuggeeResponse] + ]]: + raise NotImplementedError() + + @property + def list_active_breakpoints(self) -> Callable[ + [controller.ListActiveBreakpointsRequest], + Union[ + controller.ListActiveBreakpointsResponse, + Awaitable[controller.ListActiveBreakpointsResponse] + ]]: + raise NotImplementedError() + + @property + def update_active_breakpoint(self) -> Callable[ + [controller.UpdateActiveBreakpointRequest], + Union[ + controller.UpdateActiveBreakpointResponse, + Awaitable[controller.UpdateActiveBreakpointResponse] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'Controller2Transport', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py new file mode 100644 index 0000000..6011f18 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py @@ -0,0 +1,362 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.debugger_v2.types import controller +from .base import Controller2Transport, DEFAULT_CLIENT_INFO + + +class Controller2GrpcTransport(Controller2Transport): + """gRPC backend transport for Controller2. + + The Controller service provides the API for orchestrating a + collection of debugger agents to perform debugging tasks. These + agents are each attached to a process of an application which may + include one or more replicas. + + The debugger agents register with the Controller to identify the + application being debugged, the Debuggee. All agents that register + with the same data, represent the same Debuggee, and are assigned + the same ``debuggee_id``. + + The debugger agents call the Controller to retrieve the list of + active Breakpoints. Agents with the same ``debuggee_id`` get the + same breakpoints list. An agent that can fulfill the breakpoint + request updates the Controller with the breakpoint result. The + controller selects the first result received and discards the rest + of the results. Agents that poll again for active breakpoints will + no longer have the completed breakpoint in the list and should + remove that breakpoint from their attached process. + + The Controller service does not provide a way to retrieve the + results of a completed breakpoint. This functionality is available + using the Debugger service. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + _stubs: Dict[str, Callable] + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'clouddebugger.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def register_debuggee(self) -> Callable[ + [controller.RegisterDebuggeeRequest], + controller.RegisterDebuggeeResponse]: + r"""Return a callable for the register debuggee method over gRPC. + + Registers the debuggee with the controller service. + + All agents attached to the same application must call this + method with exactly the same request content to get back the + same stable ``debuggee_id``. Agents should call this method + again whenever ``google.rpc.Code.NOT_FOUND`` is returned from + any controller method. + + This protocol allows the controller service to disable + debuggees, recover from data loss, or change the ``debuggee_id`` + format. Agents must handle ``debuggee_id`` value changing upon + re-registration. + + Returns: + Callable[[~.RegisterDebuggeeRequest], + ~.RegisterDebuggeeResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'register_debuggee' not in self._stubs: + self._stubs['register_debuggee'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Controller2/RegisterDebuggee', + request_serializer=controller.RegisterDebuggeeRequest.serialize, + response_deserializer=controller.RegisterDebuggeeResponse.deserialize, + ) + return self._stubs['register_debuggee'] + + @property + def list_active_breakpoints(self) -> Callable[ + [controller.ListActiveBreakpointsRequest], + controller.ListActiveBreakpointsResponse]: + r"""Return a callable for the list active breakpoints method over gRPC. + + Returns the list of all active breakpoints for the debuggee. + + The breakpoint specification (``location``, ``condition``, and + ``expressions`` fields) is semantically immutable, although the + field values may change. For example, an agent may update the + location line number to reflect the actual line where the + breakpoint was set, but this doesn't change the breakpoint + semantics. + + This means that an agent does not need to check if a breakpoint + has changed when it encounters the same breakpoint on a + successive call. Moreover, an agent should remember the + breakpoints that are completed until the controller removes them + from the active list to avoid setting those breakpoints again. + + Returns: + Callable[[~.ListActiveBreakpointsRequest], + ~.ListActiveBreakpointsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_active_breakpoints' not in self._stubs: + self._stubs['list_active_breakpoints'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Controller2/ListActiveBreakpoints', + request_serializer=controller.ListActiveBreakpointsRequest.serialize, + response_deserializer=controller.ListActiveBreakpointsResponse.deserialize, + ) + return self._stubs['list_active_breakpoints'] + + @property + def update_active_breakpoint(self) -> Callable[ + [controller.UpdateActiveBreakpointRequest], + controller.UpdateActiveBreakpointResponse]: + r"""Return a callable for the update active breakpoint method over gRPC. + + Updates the breakpoint state or mutable fields. The entire + Breakpoint message must be sent back to the controller service. + + Updates to active breakpoint fields are only allowed if the new + value does not change the breakpoint specification. Updates to + the ``location``, ``condition`` and ``expressions`` fields + should not alter the breakpoint semantics. These may only make + changes such as canonicalizing a value or snapping the location + to the correct line of code. + + Returns: + Callable[[~.UpdateActiveBreakpointRequest], + ~.UpdateActiveBreakpointResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_active_breakpoint' not in self._stubs: + self._stubs['update_active_breakpoint'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Controller2/UpdateActiveBreakpoint', + request_serializer=controller.UpdateActiveBreakpointRequest.serialize, + response_deserializer=controller.UpdateActiveBreakpointResponse.deserialize, + ) + return self._stubs['update_active_breakpoint'] + + def close(self): + self.grpc_channel.close() + +__all__ = ( + 'Controller2GrpcTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py new file mode 100644 index 0000000..e60e6ca --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py @@ -0,0 +1,366 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.debugger_v2.types import controller +from .base import Controller2Transport, DEFAULT_CLIENT_INFO +from .grpc import Controller2GrpcTransport + + +class Controller2GrpcAsyncIOTransport(Controller2Transport): + """gRPC AsyncIO backend transport for Controller2. + + The Controller service provides the API for orchestrating a + collection of debugger agents to perform debugging tasks. These + agents are each attached to a process of an application which may + include one or more replicas. + + The debugger agents register with the Controller to identify the + application being debugged, the Debuggee. All agents that register + with the same data, represent the same Debuggee, and are assigned + the same ``debuggee_id``. + + The debugger agents call the Controller to retrieve the list of + active Breakpoints. Agents with the same ``debuggee_id`` get the + same breakpoints list. An agent that can fulfill the breakpoint + request updates the Controller with the breakpoint result. The + controller selects the first result received and discards the rest + of the results. Agents that poll again for active breakpoints will + no longer have the completed breakpoint in the list and should + remove that breakpoint from their attached process. + + The Controller service does not provide a way to retrieve the + results of a completed breakpoint. This functionality is available + using the Debugger service. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel(cls, + host: str = 'clouddebugger.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def register_debuggee(self) -> Callable[ + [controller.RegisterDebuggeeRequest], + Awaitable[controller.RegisterDebuggeeResponse]]: + r"""Return a callable for the register debuggee method over gRPC. + + Registers the debuggee with the controller service. + + All agents attached to the same application must call this + method with exactly the same request content to get back the + same stable ``debuggee_id``. Agents should call this method + again whenever ``google.rpc.Code.NOT_FOUND`` is returned from + any controller method. + + This protocol allows the controller service to disable + debuggees, recover from data loss, or change the ``debuggee_id`` + format. Agents must handle ``debuggee_id`` value changing upon + re-registration. + + Returns: + Callable[[~.RegisterDebuggeeRequest], + Awaitable[~.RegisterDebuggeeResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'register_debuggee' not in self._stubs: + self._stubs['register_debuggee'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Controller2/RegisterDebuggee', + request_serializer=controller.RegisterDebuggeeRequest.serialize, + response_deserializer=controller.RegisterDebuggeeResponse.deserialize, + ) + return self._stubs['register_debuggee'] + + @property + def list_active_breakpoints(self) -> Callable[ + [controller.ListActiveBreakpointsRequest], + Awaitable[controller.ListActiveBreakpointsResponse]]: + r"""Return a callable for the list active breakpoints method over gRPC. + + Returns the list of all active breakpoints for the debuggee. + + The breakpoint specification (``location``, ``condition``, and + ``expressions`` fields) is semantically immutable, although the + field values may change. For example, an agent may update the + location line number to reflect the actual line where the + breakpoint was set, but this doesn't change the breakpoint + semantics. + + This means that an agent does not need to check if a breakpoint + has changed when it encounters the same breakpoint on a + successive call. Moreover, an agent should remember the + breakpoints that are completed until the controller removes them + from the active list to avoid setting those breakpoints again. + + Returns: + Callable[[~.ListActiveBreakpointsRequest], + Awaitable[~.ListActiveBreakpointsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_active_breakpoints' not in self._stubs: + self._stubs['list_active_breakpoints'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Controller2/ListActiveBreakpoints', + request_serializer=controller.ListActiveBreakpointsRequest.serialize, + response_deserializer=controller.ListActiveBreakpointsResponse.deserialize, + ) + return self._stubs['list_active_breakpoints'] + + @property + def update_active_breakpoint(self) -> Callable[ + [controller.UpdateActiveBreakpointRequest], + Awaitable[controller.UpdateActiveBreakpointResponse]]: + r"""Return a callable for the update active breakpoint method over gRPC. + + Updates the breakpoint state or mutable fields. The entire + Breakpoint message must be sent back to the controller service. + + Updates to active breakpoint fields are only allowed if the new + value does not change the breakpoint specification. Updates to + the ``location``, ``condition`` and ``expressions`` fields + should not alter the breakpoint semantics. These may only make + changes such as canonicalizing a value or snapping the location + to the correct line of code. + + Returns: + Callable[[~.UpdateActiveBreakpointRequest], + Awaitable[~.UpdateActiveBreakpointResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'update_active_breakpoint' not in self._stubs: + self._stubs['update_active_breakpoint'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Controller2/UpdateActiveBreakpoint', + request_serializer=controller.UpdateActiveBreakpointRequest.serialize, + response_deserializer=controller.UpdateActiveBreakpointResponse.deserialize, + ) + return self._stubs['update_active_breakpoint'] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'Controller2GrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py new file mode 100644 index 0000000..ed82703 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +from .client import Debugger2Client +from .async_client import Debugger2AsyncClient + +__all__ = ( + 'Debugger2Client', + 'Debugger2AsyncClient', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py new file mode 100644 index 0000000..65a6866 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py @@ -0,0 +1,644 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +from collections import OrderedDict +import functools +import re +from typing import Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core.client_options import ClientOptions +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.debugger_v2.types import data +from google.cloud.debugger_v2.types import debugger +from .transports.base import Debugger2Transport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import Debugger2GrpcAsyncIOTransport +from .client import Debugger2Client + + +class Debugger2AsyncClient: + """The Debugger service provides the API that allows users to + collect run-time information from a running application, without + stopping or slowing it down and without modifying its state. An + application may include one or more replicated processes + performing the same work. + A debugged application is represented using the Debuggee + concept. The Debugger service provides a way to query for + available debuggees, but does not provide a way to create one. + A debuggee is created using the Controller service, usually by + running a debugger agent with the application. + The Debugger service enables the client to set one or more + Breakpoints on a Debuggee and collect the results of the set + Breakpoints. + """ + + _client: Debugger2Client + + DEFAULT_ENDPOINT = Debugger2Client.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = Debugger2Client.DEFAULT_MTLS_ENDPOINT + + common_billing_account_path = staticmethod(Debugger2Client.common_billing_account_path) + parse_common_billing_account_path = staticmethod(Debugger2Client.parse_common_billing_account_path) + common_folder_path = staticmethod(Debugger2Client.common_folder_path) + parse_common_folder_path = staticmethod(Debugger2Client.parse_common_folder_path) + common_organization_path = staticmethod(Debugger2Client.common_organization_path) + parse_common_organization_path = staticmethod(Debugger2Client.parse_common_organization_path) + common_project_path = staticmethod(Debugger2Client.common_project_path) + parse_common_project_path = staticmethod(Debugger2Client.parse_common_project_path) + common_location_path = staticmethod(Debugger2Client.common_location_path) + parse_common_location_path = staticmethod(Debugger2Client.parse_common_location_path) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + Debugger2AsyncClient: The constructed client. + """ + return Debugger2Client.from_service_account_info.__func__(Debugger2AsyncClient, info, *args, **kwargs) # type: ignore + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + Debugger2AsyncClient: The constructed client. + """ + return Debugger2Client.from_service_account_file.__func__(Debugger2AsyncClient, filename, *args, **kwargs) # type: ignore + + from_service_account_json = from_service_account_file + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variabel is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + return Debugger2Client.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> Debugger2Transport: + """Returns the transport used by the client instance. + + Returns: + Debugger2Transport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(Debugger2Client).get_transport_class, type(Debugger2Client)) + + def __init__(self, *, + credentials: ga_credentials.Credentials = None, + transport: Union[str, Debugger2Transport] = "grpc_asyncio", + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the debugger2 client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, ~.Debugger2Transport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (ClientOptions): Custom options for the client. It + won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + self._client = Debugger2Client( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def set_breakpoint(self, + request: Union[debugger.SetBreakpointRequest, dict] = None, + *, + debuggee_id: str = None, + breakpoint_: data.Breakpoint = None, + client_version: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Sets the breakpoint to the debuggee. + + Args: + request (Union[google.cloud.debugger_v2.types.SetBreakpointRequest, dict]): + The request object. Request to set a breakpoint + debuggee_id (:class:`str`): + Required. ID of the debuggee where + the breakpoint is to be set. + + This corresponds to the ``debuggee_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + breakpoint_ (:class:`google.cloud.debugger_v2.types.Breakpoint`): + Required. Breakpoint specification to set. The field + ``location`` of the breakpoint must be set. + + This corresponds to the ``breakpoint_`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + client_version (:class:`str`): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., + ``google.com/intellij/v1``). + + This corresponds to the ``client_version`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.SetBreakpointResponse: + Response for setting a breakpoint. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee_id, breakpoint_, client_version]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = debugger.SetBreakpointRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee_id is not None: + request.debuggee_id = debuggee_id + if breakpoint_ is not None: + request.breakpoint_ = breakpoint_ + if client_version is not None: + request.client_version = client_version + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.set_breakpoint, + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_breakpoint(self, + request: Union[debugger.GetBreakpointRequest, dict] = None, + *, + debuggee_id: str = None, + breakpoint_id: str = None, + client_version: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Gets breakpoint information. + + Args: + request (Union[google.cloud.debugger_v2.types.GetBreakpointRequest, dict]): + The request object. Request to get breakpoint + information. + debuggee_id (:class:`str`): + Required. ID of the debuggee whose + breakpoint to get. + + This corresponds to the ``debuggee_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + breakpoint_id (:class:`str`): + Required. ID of the breakpoint to + get. + + This corresponds to the ``breakpoint_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + client_version (:class:`str`): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., + ``google.com/intellij/v1``). + + This corresponds to the ``client_version`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.GetBreakpointResponse: + Response for getting breakpoint + information. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee_id, breakpoint_id, client_version]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = debugger.GetBreakpointRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee_id is not None: + request.debuggee_id = debuggee_id + if breakpoint_id is not None: + request.breakpoint_id = breakpoint_id + if client_version is not None: + request.client_version = client_version + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.get_breakpoint, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=600.0, + ), + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_breakpoint(self, + request: Union[debugger.DeleteBreakpointRequest, dict] = None, + *, + debuggee_id: str = None, + breakpoint_id: str = None, + client_version: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the breakpoint from the debuggee. + + Args: + request (Union[google.cloud.debugger_v2.types.DeleteBreakpointRequest, dict]): + The request object. Request to delete a breakpoint. + debuggee_id (:class:`str`): + Required. ID of the debuggee whose + breakpoint to delete. + + This corresponds to the ``debuggee_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + breakpoint_id (:class:`str`): + Required. ID of the breakpoint to + delete. + + This corresponds to the ``breakpoint_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + client_version (:class:`str`): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., + ``google.com/intellij/v1``). + + This corresponds to the ``client_version`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee_id, breakpoint_id, client_version]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = debugger.DeleteBreakpointRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee_id is not None: + request.debuggee_id = debuggee_id + if breakpoint_id is not None: + request.breakpoint_id = breakpoint_id + if client_version is not None: + request.client_version = client_version + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.delete_breakpoint, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=600.0, + ), + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def list_breakpoints(self, + request: Union[debugger.ListBreakpointsRequest, dict] = None, + *, + debuggee_id: str = None, + client_version: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Lists all breakpoints for the debuggee. + + Args: + request (Union[google.cloud.debugger_v2.types.ListBreakpointsRequest, dict]): + The request object. Request to list breakpoints. + debuggee_id (:class:`str`): + Required. ID of the debuggee whose + breakpoints to list. + + This corresponds to the ``debuggee_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + client_version (:class:`str`): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., + ``google.com/intellij/v1``). + + This corresponds to the ``client_version`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.ListBreakpointsResponse: + Response for listing breakpoints. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee_id, client_version]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = debugger.ListBreakpointsRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee_id is not None: + request.debuggee_id = debuggee_id + if client_version is not None: + request.client_version = client_version + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_breakpoints, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=600.0, + ), + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def list_debuggees(self, + request: Union[debugger.ListDebuggeesRequest, dict] = None, + *, + project: str = None, + client_version: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Lists all the debuggees that the user has access to. + + Args: + request (Union[google.cloud.debugger_v2.types.ListDebuggeesRequest, dict]): + The request object. Request to list debuggees. + project (:class:`str`): + Required. Project number of a Google + Cloud project whose debuggees to list. + + This corresponds to the ``project`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + client_version (:class:`str`): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., + ``google.com/intellij/v1``). + + This corresponds to the ``client_version`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.ListDebuggeesResponse: + Response for listing debuggees. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([project, client_version]) + if request is not None and has_flattened_params: + raise ValueError("If the `request` argument is set, then none of " + "the individual field arguments should be set.") + + request = debugger.ListDebuggeesRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if project is not None: + request.project = project + if client_version is not None: + request.client_version = client_version + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = gapic_v1.method_async.wrap_method( + self._client._transport.list_debuggees, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=600.0, + ), + default_timeout=600.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self): + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-debugger-client", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "Debugger2AsyncClient", +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py new file mode 100644 index 0000000..ce6b5fb --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py @@ -0,0 +1,803 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +from collections import OrderedDict +import os +import re +from typing import Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport import mtls # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.exceptions import MutualTLSChannelError # type: ignore +from google.oauth2 import service_account # type: ignore + +try: + OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object] # type: ignore + +from google.cloud.debugger_v2.types import data +from google.cloud.debugger_v2.types import debugger +from .transports.base import Debugger2Transport, DEFAULT_CLIENT_INFO +from .transports.grpc import Debugger2GrpcTransport +from .transports.grpc_asyncio import Debugger2GrpcAsyncIOTransport + + +class Debugger2ClientMeta(type): + """Metaclass for the Debugger2 client. + + This provides class-level methods for building and retrieving + support objects (e.g. transport) without polluting the client instance + objects. + """ + _transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] + _transport_registry["grpc"] = Debugger2GrpcTransport + _transport_registry["grpc_asyncio"] = Debugger2GrpcAsyncIOTransport + + def get_transport_class(cls, + label: str = None, + ) -> Type[Debugger2Transport]: + """Returns an appropriate transport class. + + Args: + label: The name of the desired transport. If none is + provided, then the first transport in the registry is used. + + Returns: + The transport class to use. + """ + # If a specific transport is requested, return that one. + if label: + return cls._transport_registry[label] + + # No transport is requested; return the default (that is, the first one + # in the dictionary). + return next(iter(cls._transport_registry.values())) + + +class Debugger2Client(metaclass=Debugger2ClientMeta): + """The Debugger service provides the API that allows users to + collect run-time information from a running application, without + stopping or slowing it down and without modifying its state. An + application may include one or more replicated processes + performing the same work. + A debugged application is represented using the Debuggee + concept. The Debugger service provides a way to query for + available debuggees, but does not provide a way to create one. + A debuggee is created using the Controller service, usually by + running a debugger agent with the application. + The Debugger service enables the client to set one or more + Breakpoints on a Debuggee and collect the results of the set + Breakpoints. + """ + + @staticmethod + def _get_default_mtls_endpoint(api_endpoint): + """Converts api endpoint to mTLS endpoint. + + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = "clouddebugger.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials + info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + Debugger2Client: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_info(info) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + @classmethod + def from_service_account_file(cls, filename: str, *args, **kwargs): + """Creates an instance of this client using the provided credentials + file. + + Args: + filename (str): The path to the service account private key json + file. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + Debugger2Client: The constructed client. + """ + credentials = service_account.Credentials.from_service_account_file( + filename) + kwargs["credentials"] = credentials + return cls(*args, **kwargs) + + from_service_account_json = from_service_account_file + + @property + def transport(self) -> Debugger2Transport: + """Returns the transport used by the client instance. + + Returns: + Debugger2Transport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def common_billing_account_path(billing_account: str, ) -> str: + """Returns a fully-qualified billing_account string.""" + return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + + @staticmethod + def parse_common_billing_account_path(path: str) -> Dict[str,str]: + """Parse a billing_account path into its component segments.""" + m = re.match(r"^billingAccounts/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_folder_path(folder: str, ) -> str: + """Returns a fully-qualified folder string.""" + return "folders/{folder}".format(folder=folder, ) + + @staticmethod + def parse_common_folder_path(path: str) -> Dict[str,str]: + """Parse a folder path into its component segments.""" + m = re.match(r"^folders/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_organization_path(organization: str, ) -> str: + """Returns a fully-qualified organization string.""" + return "organizations/{organization}".format(organization=organization, ) + + @staticmethod + def parse_common_organization_path(path: str) -> Dict[str,str]: + """Parse a organization path into its component segments.""" + m = re.match(r"^organizations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_project_path(project: str, ) -> str: + """Returns a fully-qualified project string.""" + return "projects/{project}".format(project=project, ) + + @staticmethod + def parse_common_project_path(path: str) -> Dict[str,str]: + """Parse a project path into its component segments.""" + m = re.match(r"^projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def common_location_path(project: str, location: str, ) -> str: + """Returns a fully-qualified location string.""" + return "projects/{project}/locations/{location}".format(project=project, location=location, ) + + @staticmethod + def parse_common_location_path(path: str) -> Dict[str,str]: + """Parse a location path into its component segments.""" + m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) + return m.groupdict() if m else {} + + @classmethod + def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): + """Return the API endpoint and client cert source for mutual TLS. + + The client cert source is determined in the following order: + (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the + client cert source is None. + (2) if `client_options.client_cert_source` is provided, use the provided one; if the + default client cert source exists, use the default one; otherwise the client cert + source is None. + + The API endpoint is determined in the following order: + (1) if `client_options.api_endpoint` if provided, use the provided one. + (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the + default mTLS endpoint; if the environment variabel is "never", use the default API + endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise + use the default API endpoint. + + More details can be found at https://google.aip.dev/auth/4114. + + Args: + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. Only the `api_endpoint` and `client_cert_source` properties may be used + in this method. + + Returns: + Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the + client cert source to use. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If any errors happen. + """ + if client_options is None: + client_options = client_options_lib.ClientOptions() + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_client_cert not in ("true", "false"): + raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") + if use_mtls_endpoint not in ("auto", "never", "always"): + raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") + + # Figure out the client cert source to use. + client_cert_source = None + if use_client_cert == "true": + if client_options.client_cert_source: + client_cert_source = client_options.client_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + api_endpoint = cls.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = cls.DEFAULT_ENDPOINT + + return api_endpoint, client_cert_source + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Union[str, Debugger2Transport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the debugger2 client. + + Args: + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + transport (Union[str, Debugger2Transport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + + api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) + + api_key_value = getattr(client_options, "api_key", None) + if api_key_value and credentials: + raise ValueError("client_options.api_key and credentials are mutually exclusive") + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, Debugger2Transport): + # transport is a Debugger2Transport instance. + if credentials or client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = transport + else: + import google.auth._default # type: ignore + + if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): + credentials = google.auth._default.get_api_key_credentials(api_key_value) + + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + ) + + def set_breakpoint(self, + request: Union[debugger.SetBreakpointRequest, dict] = None, + *, + debuggee_id: str = None, + breakpoint_: data.Breakpoint = None, + client_version: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Sets the breakpoint to the debuggee. + + Args: + request (Union[google.cloud.debugger_v2.types.SetBreakpointRequest, dict]): + The request object. Request to set a breakpoint + debuggee_id (str): + Required. ID of the debuggee where + the breakpoint is to be set. + + This corresponds to the ``debuggee_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + breakpoint_ (google.cloud.debugger_v2.types.Breakpoint): + Required. Breakpoint specification to set. The field + ``location`` of the breakpoint must be set. + + This corresponds to the ``breakpoint_`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + client_version (str): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., + ``google.com/intellij/v1``). + + This corresponds to the ``client_version`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.SetBreakpointResponse: + Response for setting a breakpoint. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee_id, breakpoint_, client_version]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a debugger.SetBreakpointRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, debugger.SetBreakpointRequest): + request = debugger.SetBreakpointRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee_id is not None: + request.debuggee_id = debuggee_id + if breakpoint_ is not None: + request.breakpoint_ = breakpoint_ + if client_version is not None: + request.client_version = client_version + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.set_breakpoint] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_breakpoint(self, + request: Union[debugger.GetBreakpointRequest, dict] = None, + *, + debuggee_id: str = None, + breakpoint_id: str = None, + client_version: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Gets breakpoint information. + + Args: + request (Union[google.cloud.debugger_v2.types.GetBreakpointRequest, dict]): + The request object. Request to get breakpoint + information. + debuggee_id (str): + Required. ID of the debuggee whose + breakpoint to get. + + This corresponds to the ``debuggee_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + breakpoint_id (str): + Required. ID of the breakpoint to + get. + + This corresponds to the ``breakpoint_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + client_version (str): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., + ``google.com/intellij/v1``). + + This corresponds to the ``client_version`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.GetBreakpointResponse: + Response for getting breakpoint + information. + + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee_id, breakpoint_id, client_version]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a debugger.GetBreakpointRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, debugger.GetBreakpointRequest): + request = debugger.GetBreakpointRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee_id is not None: + request.debuggee_id = debuggee_id + if breakpoint_id is not None: + request.breakpoint_id = breakpoint_id + if client_version is not None: + request.client_version = client_version + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_breakpoint] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_breakpoint(self, + request: Union[debugger.DeleteBreakpointRequest, dict] = None, + *, + debuggee_id: str = None, + breakpoint_id: str = None, + client_version: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the breakpoint from the debuggee. + + Args: + request (Union[google.cloud.debugger_v2.types.DeleteBreakpointRequest, dict]): + The request object. Request to delete a breakpoint. + debuggee_id (str): + Required. ID of the debuggee whose + breakpoint to delete. + + This corresponds to the ``debuggee_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + breakpoint_id (str): + Required. ID of the breakpoint to + delete. + + This corresponds to the ``breakpoint_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + client_version (str): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., + ``google.com/intellij/v1``). + + This corresponds to the ``client_version`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee_id, breakpoint_id, client_version]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a debugger.DeleteBreakpointRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, debugger.DeleteBreakpointRequest): + request = debugger.DeleteBreakpointRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee_id is not None: + request.debuggee_id = debuggee_id + if breakpoint_id is not None: + request.breakpoint_id = breakpoint_id + if client_version is not None: + request.client_version = client_version + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_breakpoint] + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def list_breakpoints(self, + request: Union[debugger.ListBreakpointsRequest, dict] = None, + *, + debuggee_id: str = None, + client_version: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Lists all breakpoints for the debuggee. + + Args: + request (Union[google.cloud.debugger_v2.types.ListBreakpointsRequest, dict]): + The request object. Request to list breakpoints. + debuggee_id (str): + Required. ID of the debuggee whose + breakpoints to list. + + This corresponds to the ``debuggee_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + client_version (str): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., + ``google.com/intellij/v1``). + + This corresponds to the ``client_version`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.ListBreakpointsResponse: + Response for listing breakpoints. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([debuggee_id, client_version]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a debugger.ListBreakpointsRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, debugger.ListBreakpointsRequest): + request = debugger.ListBreakpointsRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if debuggee_id is not None: + request.debuggee_id = debuggee_id + if client_version is not None: + request.client_version = client_version + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_breakpoints] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_debuggees(self, + request: Union[debugger.ListDebuggeesRequest, dict] = None, + *, + project: str = None, + client_version: str = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Lists all the debuggees that the user has access to. + + Args: + request (Union[google.cloud.debugger_v2.types.ListDebuggeesRequest, dict]): + The request object. Request to list debuggees. + project (str): + Required. Project number of a Google + Cloud project whose debuggees to list. + + This corresponds to the ``project`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + client_version (str): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., + ``google.com/intellij/v1``). + + This corresponds to the ``client_version`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be retried. + timeout (float): The timeout for this request. + metadata (Sequence[Tuple[str, str]]): Strings which should be + sent along with the request as metadata. + + Returns: + google.cloud.debugger_v2.types.ListDebuggeesResponse: + Response for listing debuggees. + """ + # Create or coerce a protobuf request object. + # Quick check: If we got a request object, we should *not* have + # gotten any keyword arguments that map to the request. + has_flattened_params = any([project, client_version]) + if request is not None and has_flattened_params: + raise ValueError('If the `request` argument is set, then none of ' + 'the individual field arguments should be set.') + + # Minor optimization to avoid making a copy if the user passes + # in a debugger.ListDebuggeesRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + if not isinstance(request, debugger.ListDebuggeesRequest): + request = debugger.ListDebuggeesRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if project is not None: + request.project = project + if client_version is not None: + request.client_version = client_version + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.list_debuggees] + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self): + return self + + def __exit__(self, type, value, traceback): + """Releases underlying transport's resources. + + .. warning:: + ONLY use as a context manager if the transport is NOT shared + with other clients! Exiting the with block will CLOSE the transport + and may cause errors in other clients! + """ + self.transport.close() + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + "google-cloud-debugger-client", + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + "Debugger2Client", +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py new file mode 100644 index 0000000..1dc29ef --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py @@ -0,0 +1,33 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +from collections import OrderedDict +from typing import Dict, Type + +from .base import Debugger2Transport +from .grpc import Debugger2GrpcTransport +from .grpc_asyncio import Debugger2GrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] +_transport_registry['grpc'] = Debugger2GrpcTransport +_transport_registry['grpc_asyncio'] = Debugger2GrpcAsyncIOTransport + +__all__ = ( + 'Debugger2Transport', + 'Debugger2GrpcTransport', + 'Debugger2GrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py new file mode 100644 index 0000000..d9fa8de --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py @@ -0,0 +1,231 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import abc +from typing import Awaitable, Callable, Dict, Optional, Sequence, Union +import pkg_resources + +import google.auth # type: ignore +import google.api_core +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import retry as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.debugger_v2.types import debugger +from google.protobuf import empty_pb2 # type: ignore + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-debugger-client', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +class Debugger2Transport(abc.ABC): + """Abstract transport class for Debugger2.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/cloud_debugger', + ) + + DEFAULT_HOST: str = 'clouddebugger.googleapis.com' + def __init__( + self, *, + host: str = DEFAULT_HOST, + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A list of scopes. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} + + # Save the scopes. + self._scopes = scopes + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = google.auth.load_credentials_from_file( + credentials_file, + **scopes_kwargs, + quota_project_id=quota_project_id + ) + elif credentials is None: + credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) + + # If the credentials are service account credentials, then always try to use self signed JWT. + if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): + credentials = credentials.with_always_use_jwt_access(True) + + # Save the credentials. + self._credentials = credentials + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.set_breakpoint: gapic_v1.method.wrap_method( + self.set_breakpoint, + default_timeout=600.0, + client_info=client_info, + ), + self.get_breakpoint: gapic_v1.method.wrap_method( + self.get_breakpoint, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=600.0, + ), + default_timeout=600.0, + client_info=client_info, + ), + self.delete_breakpoint: gapic_v1.method.wrap_method( + self.delete_breakpoint, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=600.0, + ), + default_timeout=600.0, + client_info=client_info, + ), + self.list_breakpoints: gapic_v1.method.wrap_method( + self.list_breakpoints, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=600.0, + ), + default_timeout=600.0, + client_info=client_info, + ), + self.list_debuggees: gapic_v1.method.wrap_method( + self.list_debuggees, + default_retry=retries.Retry( +initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=600.0, + ), + default_timeout=600.0, + client_info=client_info, + ), + } + + def close(self): + """Closes resources associated with the transport. + + .. warning:: + Only call this method if the transport is NOT shared + with other clients - this may cause errors in other clients! + """ + raise NotImplementedError() + + @property + def set_breakpoint(self) -> Callable[ + [debugger.SetBreakpointRequest], + Union[ + debugger.SetBreakpointResponse, + Awaitable[debugger.SetBreakpointResponse] + ]]: + raise NotImplementedError() + + @property + def get_breakpoint(self) -> Callable[ + [debugger.GetBreakpointRequest], + Union[ + debugger.GetBreakpointResponse, + Awaitable[debugger.GetBreakpointResponse] + ]]: + raise NotImplementedError() + + @property + def delete_breakpoint(self) -> Callable[ + [debugger.DeleteBreakpointRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def list_breakpoints(self) -> Callable[ + [debugger.ListBreakpointsRequest], + Union[ + debugger.ListBreakpointsResponse, + Awaitable[debugger.ListBreakpointsResponse] + ]]: + raise NotImplementedError() + + @property + def list_debuggees(self) -> Callable[ + [debugger.ListDebuggeesRequest], + Union[ + debugger.ListDebuggeesResponse, + Awaitable[debugger.ListDebuggeesResponse] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'Debugger2Transport', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py new file mode 100644 index 0000000..38edbff --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py @@ -0,0 +1,374 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import grpc_helpers +from google.api_core import gapic_v1 +import google.auth # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.debugger_v2.types import debugger +from google.protobuf import empty_pb2 # type: ignore +from .base import Debugger2Transport, DEFAULT_CLIENT_INFO + + +class Debugger2GrpcTransport(Debugger2Transport): + """gRPC backend transport for Debugger2. + + The Debugger service provides the API that allows users to + collect run-time information from a running application, without + stopping or slowing it down and without modifying its state. An + application may include one or more replicated processes + performing the same work. + A debugged application is represented using the Debuggee + concept. The Debugger service provides a way to query for + available debuggees, but does not provide a way to create one. + A debuggee is created using the Controller service, usually by + running a debugger agent with the application. + The Debugger service enables the client to set one or more + Breakpoints on a Debuggee and collect the results of the set + Breakpoints. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + _stubs: Dict[str, Callable] + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @classmethod + def create_channel(cls, + host: str = 'clouddebugger.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def set_breakpoint(self) -> Callable[ + [debugger.SetBreakpointRequest], + debugger.SetBreakpointResponse]: + r"""Return a callable for the set breakpoint method over gRPC. + + Sets the breakpoint to the debuggee. + + Returns: + Callable[[~.SetBreakpointRequest], + ~.SetBreakpointResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'set_breakpoint' not in self._stubs: + self._stubs['set_breakpoint'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Debugger2/SetBreakpoint', + request_serializer=debugger.SetBreakpointRequest.serialize, + response_deserializer=debugger.SetBreakpointResponse.deserialize, + ) + return self._stubs['set_breakpoint'] + + @property + def get_breakpoint(self) -> Callable[ + [debugger.GetBreakpointRequest], + debugger.GetBreakpointResponse]: + r"""Return a callable for the get breakpoint method over gRPC. + + Gets breakpoint information. + + Returns: + Callable[[~.GetBreakpointRequest], + ~.GetBreakpointResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_breakpoint' not in self._stubs: + self._stubs['get_breakpoint'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Debugger2/GetBreakpoint', + request_serializer=debugger.GetBreakpointRequest.serialize, + response_deserializer=debugger.GetBreakpointResponse.deserialize, + ) + return self._stubs['get_breakpoint'] + + @property + def delete_breakpoint(self) -> Callable[ + [debugger.DeleteBreakpointRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete breakpoint method over gRPC. + + Deletes the breakpoint from the debuggee. + + Returns: + Callable[[~.DeleteBreakpointRequest], + ~.Empty]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_breakpoint' not in self._stubs: + self._stubs['delete_breakpoint'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Debugger2/DeleteBreakpoint', + request_serializer=debugger.DeleteBreakpointRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_breakpoint'] + + @property + def list_breakpoints(self) -> Callable[ + [debugger.ListBreakpointsRequest], + debugger.ListBreakpointsResponse]: + r"""Return a callable for the list breakpoints method over gRPC. + + Lists all breakpoints for the debuggee. + + Returns: + Callable[[~.ListBreakpointsRequest], + ~.ListBreakpointsResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_breakpoints' not in self._stubs: + self._stubs['list_breakpoints'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Debugger2/ListBreakpoints', + request_serializer=debugger.ListBreakpointsRequest.serialize, + response_deserializer=debugger.ListBreakpointsResponse.deserialize, + ) + return self._stubs['list_breakpoints'] + + @property + def list_debuggees(self) -> Callable[ + [debugger.ListDebuggeesRequest], + debugger.ListDebuggeesResponse]: + r"""Return a callable for the list debuggees method over gRPC. + + Lists all the debuggees that the user has access to. + + Returns: + Callable[[~.ListDebuggeesRequest], + ~.ListDebuggeesResponse]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_debuggees' not in self._stubs: + self._stubs['list_debuggees'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Debugger2/ListDebuggees', + request_serializer=debugger.ListDebuggeesRequest.serialize, + response_deserializer=debugger.ListDebuggeesResponse.deserialize, + ) + return self._stubs['list_debuggees'] + + def close(self): + self.grpc_channel.close() + +__all__ = ( + 'Debugger2GrpcTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py new file mode 100644 index 0000000..66ac586 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py @@ -0,0 +1,378 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union + +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers_async +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore +from grpc.experimental import aio # type: ignore + +from google.cloud.debugger_v2.types import debugger +from google.protobuf import empty_pb2 # type: ignore +from .base import Debugger2Transport, DEFAULT_CLIENT_INFO +from .grpc import Debugger2GrpcTransport + + +class Debugger2GrpcAsyncIOTransport(Debugger2Transport): + """gRPC AsyncIO backend transport for Debugger2. + + The Debugger service provides the API that allows users to + collect run-time information from a running application, without + stopping or slowing it down and without modifying its state. An + application may include one or more replicated processes + performing the same work. + A debugged application is represented using the Debuggee + concept. The Debugger service provides a way to query for + available debuggees, but does not provide a way to create one. + A debuggee is created using the Controller service, usually by + running a debugger agent with the application. + The Debugger service enables the client to set one or more + Breakpoints on a Debuggee and collect the results of the set + Breakpoints. + + This class defines the same methods as the primary client, so the + primary client can load the underlying transport implementation + and call it. + + It sends protocol buffers over the wire using gRPC (which is built on + top of HTTP/2); the ``grpcio`` package must be installed. + """ + + _grpc_channel: aio.Channel + _stubs: Dict[str, Callable] = {} + + @classmethod + def create_channel(cls, + host: str = 'clouddebugger.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + quota_project_id=quota_project_id, + default_scopes=cls.AUTH_SCOPES, + scopes=scopes, + default_host=cls.DEFAULT_HOST, + **kwargs + ) + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: ga_credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + always_use_jwt_access: Optional[bool] = False, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or application default SSL credentials. + client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): + Deprecated. A callback to provide client SSL certificate bytes and + private key bytes, both in PEM format. It is ignored if + ``api_mtls_endpoint`` is None. + ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials + for the grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure a mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + # use the credentials which are saved + credentials=self._credentials, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, + scopes=self._scopes, + ssl_credentials=self._ssl_channel_credentials, + quota_project_id=quota_project_id, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Wrap messages. This must be done after self._grpc_channel exists + self._prep_wrapped_messages(client_info) + + @property + def grpc_channel(self) -> aio.Channel: + """Create the channel designed to connect to this service. + + This property caches on the instance; repeated calls return + the same channel. + """ + # Return the channel from cache. + return self._grpc_channel + + @property + def set_breakpoint(self) -> Callable[ + [debugger.SetBreakpointRequest], + Awaitable[debugger.SetBreakpointResponse]]: + r"""Return a callable for the set breakpoint method over gRPC. + + Sets the breakpoint to the debuggee. + + Returns: + Callable[[~.SetBreakpointRequest], + Awaitable[~.SetBreakpointResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'set_breakpoint' not in self._stubs: + self._stubs['set_breakpoint'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Debugger2/SetBreakpoint', + request_serializer=debugger.SetBreakpointRequest.serialize, + response_deserializer=debugger.SetBreakpointResponse.deserialize, + ) + return self._stubs['set_breakpoint'] + + @property + def get_breakpoint(self) -> Callable[ + [debugger.GetBreakpointRequest], + Awaitable[debugger.GetBreakpointResponse]]: + r"""Return a callable for the get breakpoint method over gRPC. + + Gets breakpoint information. + + Returns: + Callable[[~.GetBreakpointRequest], + Awaitable[~.GetBreakpointResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'get_breakpoint' not in self._stubs: + self._stubs['get_breakpoint'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Debugger2/GetBreakpoint', + request_serializer=debugger.GetBreakpointRequest.serialize, + response_deserializer=debugger.GetBreakpointResponse.deserialize, + ) + return self._stubs['get_breakpoint'] + + @property + def delete_breakpoint(self) -> Callable[ + [debugger.DeleteBreakpointRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete breakpoint method over gRPC. + + Deletes the breakpoint from the debuggee. + + Returns: + Callable[[~.DeleteBreakpointRequest], + Awaitable[~.Empty]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'delete_breakpoint' not in self._stubs: + self._stubs['delete_breakpoint'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Debugger2/DeleteBreakpoint', + request_serializer=debugger.DeleteBreakpointRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_breakpoint'] + + @property + def list_breakpoints(self) -> Callable[ + [debugger.ListBreakpointsRequest], + Awaitable[debugger.ListBreakpointsResponse]]: + r"""Return a callable for the list breakpoints method over gRPC. + + Lists all breakpoints for the debuggee. + + Returns: + Callable[[~.ListBreakpointsRequest], + Awaitable[~.ListBreakpointsResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_breakpoints' not in self._stubs: + self._stubs['list_breakpoints'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Debugger2/ListBreakpoints', + request_serializer=debugger.ListBreakpointsRequest.serialize, + response_deserializer=debugger.ListBreakpointsResponse.deserialize, + ) + return self._stubs['list_breakpoints'] + + @property + def list_debuggees(self) -> Callable[ + [debugger.ListDebuggeesRequest], + Awaitable[debugger.ListDebuggeesResponse]]: + r"""Return a callable for the list debuggees method over gRPC. + + Lists all the debuggees that the user has access to. + + Returns: + Callable[[~.ListDebuggeesRequest], + Awaitable[~.ListDebuggeesResponse]]: + A function that, when called, will call the underlying RPC + on the server. + """ + # Generate a "stub function" on-the-fly which will actually make + # the request. + # gRPC handles serialization and deserialization, so we just need + # to pass in the functions for each. + if 'list_debuggees' not in self._stubs: + self._stubs['list_debuggees'] = self.grpc_channel.unary_unary( + '/google.devtools.clouddebugger.v2.Debugger2/ListDebuggees', + request_serializer=debugger.ListDebuggeesRequest.serialize, + response_deserializer=debugger.ListDebuggeesResponse.deserialize, + ) + return self._stubs['list_debuggees'] + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'Debugger2GrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py new file mode 100644 index 0000000..047c89e --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py @@ -0,0 +1,68 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +from .controller import ( + ListActiveBreakpointsRequest, + ListActiveBreakpointsResponse, + RegisterDebuggeeRequest, + RegisterDebuggeeResponse, + UpdateActiveBreakpointRequest, + UpdateActiveBreakpointResponse, +) +from .data import ( + Breakpoint, + Debuggee, + FormatMessage, + SourceLocation, + StackFrame, + StatusMessage, + Variable, +) +from .debugger import ( + DeleteBreakpointRequest, + GetBreakpointRequest, + GetBreakpointResponse, + ListBreakpointsRequest, + ListBreakpointsResponse, + ListDebuggeesRequest, + ListDebuggeesResponse, + SetBreakpointRequest, + SetBreakpointResponse, +) + +__all__ = ( + 'ListActiveBreakpointsRequest', + 'ListActiveBreakpointsResponse', + 'RegisterDebuggeeRequest', + 'RegisterDebuggeeResponse', + 'UpdateActiveBreakpointRequest', + 'UpdateActiveBreakpointResponse', + 'Breakpoint', + 'Debuggee', + 'FormatMessage', + 'SourceLocation', + 'StackFrame', + 'StatusMessage', + 'Variable', + 'DeleteBreakpointRequest', + 'GetBreakpointRequest', + 'GetBreakpointResponse', + 'ListBreakpointsRequest', + 'ListBreakpointsResponse', + 'ListDebuggeesRequest', + 'ListDebuggeesResponse', + 'SetBreakpointRequest', + 'SetBreakpointResponse', +) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py b/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py new file mode 100644 index 0000000..7eea2a6 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py @@ -0,0 +1,172 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import proto # type: ignore + +from google.cloud.debugger_v2.types import data + + +__protobuf__ = proto.module( + package='google.devtools.clouddebugger.v2', + manifest={ + 'RegisterDebuggeeRequest', + 'RegisterDebuggeeResponse', + 'ListActiveBreakpointsRequest', + 'ListActiveBreakpointsResponse', + 'UpdateActiveBreakpointRequest', + 'UpdateActiveBreakpointResponse', + }, +) + + +class RegisterDebuggeeRequest(proto.Message): + r"""Request to register a debuggee. + + Attributes: + debuggee (google.cloud.debugger_v2.types.Debuggee): + Required. Debuggee information to register. The fields + ``project``, ``uniquifier``, ``description`` and + ``agent_version`` of the debuggee must be set. + """ + + debuggee = proto.Field( + proto.MESSAGE, + number=1, + message=data.Debuggee, + ) + + +class RegisterDebuggeeResponse(proto.Message): + r"""Response for registering a debuggee. + + Attributes: + debuggee (google.cloud.debugger_v2.types.Debuggee): + Debuggee resource. The field ``id`` is guaranteed to be set + (in addition to the echoed fields). If the field + ``is_disabled`` is set to ``true``, the agent should disable + itself by removing all breakpoints and detaching from the + application. It should however continue to poll + ``RegisterDebuggee`` until reenabled. + """ + + debuggee = proto.Field( + proto.MESSAGE, + number=1, + message=data.Debuggee, + ) + + +class ListActiveBreakpointsRequest(proto.Message): + r"""Request to list active breakpoints. + + Attributes: + debuggee_id (str): + Required. Identifies the debuggee. + wait_token (str): + A token that, if specified, blocks the method call until the + list of active breakpoints has changed, or a server-selected + timeout has expired. The value should be set from the + ``next_wait_token`` field in the last response. The initial + value should be set to ``"init"``. + success_on_timeout (bool): + If set to ``true`` (recommended), returns + ``google.rpc.Code.OK`` status and sets the ``wait_expired`` + response field to ``true`` when the server-selected timeout + has expired. + + If set to ``false`` (deprecated), returns + ``google.rpc.Code.ABORTED`` status when the server-selected + timeout has expired. + """ + + debuggee_id = proto.Field( + proto.STRING, + number=1, + ) + wait_token = proto.Field( + proto.STRING, + number=2, + ) + success_on_timeout = proto.Field( + proto.BOOL, + number=3, + ) + + +class ListActiveBreakpointsResponse(proto.Message): + r"""Response for listing active breakpoints. + + Attributes: + breakpoints (Sequence[google.cloud.debugger_v2.types.Breakpoint]): + List of all active breakpoints. The fields ``id`` and + ``location`` are guaranteed to be set on each breakpoint. + next_wait_token (str): + A token that can be used in the next method + call to block until the list of breakpoints + changes. + wait_expired (bool): + If set to ``true``, indicates that there is no change to the + list of active breakpoints and the server-selected timeout + has expired. The ``breakpoints`` field would be empty and + should be ignored. + """ + + breakpoints = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + next_wait_token = proto.Field( + proto.STRING, + number=2, + ) + wait_expired = proto.Field( + proto.BOOL, + number=3, + ) + + +class UpdateActiveBreakpointRequest(proto.Message): + r"""Request to update an active breakpoint. + + Attributes: + debuggee_id (str): + Required. Identifies the debuggee being + debugged. + breakpoint_ (google.cloud.debugger_v2.types.Breakpoint): + Required. Updated breakpoint information. The field ``id`` + must be set. The agent must echo all Breakpoint + specification fields in the update. + """ + + debuggee_id = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_ = proto.Field( + proto.MESSAGE, + number=2, + message=data.Breakpoint, + ) + + +class UpdateActiveBreakpointResponse(proto.Message): + r"""Response for updating an active breakpoint. + The message is defined to allow future extensions. + + """ + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py b/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py new file mode 100644 index 0000000..f743b48 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py @@ -0,0 +1,636 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import proto # type: ignore + +from google.devtools.source.v1 import source_context_pb2 # type: ignore +from google.protobuf import timestamp_pb2 # type: ignore +from google.protobuf import wrappers_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.devtools.clouddebugger.v2', + manifest={ + 'FormatMessage', + 'StatusMessage', + 'SourceLocation', + 'Variable', + 'StackFrame', + 'Breakpoint', + 'Debuggee', + }, +) + + +class FormatMessage(proto.Message): + r"""Represents a message with parameters. + + Attributes: + format_ (str): + Format template for the message. The ``format`` uses + placeholders ``$0``, ``$1``, etc. to reference parameters. + ``$$`` can be used to denote the ``$`` character. + + Examples: + + - ``Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.`` + - ``Please pay $$10 to use $0 instead of $1.`` + parameters (Sequence[str]): + Optional parameters to be embedded into the + message. + """ + + format_ = proto.Field( + proto.STRING, + number=1, + ) + parameters = proto.RepeatedField( + proto.STRING, + number=2, + ) + + +class StatusMessage(proto.Message): + r"""Represents a contextual status message. The message can indicate an + error or informational status, and refer to specific parts of the + containing object. For example, the ``Breakpoint.status`` field can + indicate an error referring to the ``BREAKPOINT_SOURCE_LOCATION`` + with the message ``Location not found``. + + Attributes: + is_error (bool): + Distinguishes errors from informational + messages. + refers_to (google.cloud.debugger_v2.types.StatusMessage.Reference): + Reference to which the message applies. + description (google.cloud.debugger_v2.types.FormatMessage): + Status message text. + """ + class Reference(proto.Enum): + r"""Enumerates references to which the message applies.""" + UNSPECIFIED = 0 + BREAKPOINT_SOURCE_LOCATION = 3 + BREAKPOINT_CONDITION = 4 + BREAKPOINT_EXPRESSION = 7 + BREAKPOINT_AGE = 8 + VARIABLE_NAME = 5 + VARIABLE_VALUE = 6 + + is_error = proto.Field( + proto.BOOL, + number=1, + ) + refers_to = proto.Field( + proto.ENUM, + number=2, + enum=Reference, + ) + description = proto.Field( + proto.MESSAGE, + number=3, + message='FormatMessage', + ) + + +class SourceLocation(proto.Message): + r"""Represents a location in the source code. + + Attributes: + path (str): + Path to the source file within the source + context of the target binary. + line (int): + Line inside the file. The first line in the file has the + value ``1``. + column (int): + Column within a line. The first column in a line as the + value ``1``. Agents that do not support setting breakpoints + on specific columns ignore this field. + """ + + path = proto.Field( + proto.STRING, + number=1, + ) + line = proto.Field( + proto.INT32, + number=2, + ) + column = proto.Field( + proto.INT32, + number=3, + ) + + +class Variable(proto.Message): + r"""Represents a variable or an argument possibly of a compound object + type. Note how the following variables are represented: + + 1) A simple variable: + + int x = 5 + + { name: "x", value: "5", type: "int" } // Captured variable + + 2) A compound object: + + struct T { int m1; int m2; }; T x = { 3, 7 }; + + { // Captured variable name: "x", type: "T", members { name: + "m1", value: "3", type: "int" }, members { name: "m2", value: + "7", type: "int" } } + + 3) A pointer where the pointee was captured: + + T x = { 3, 7 }; T\* p = &x; + + { // Captured variable name: "p", type: "T*", value: + "0x00500500", members { name: "m1", value: "3", type: "int" }, + members { name: "m2", value: "7", type: "int" } } + + 4) A pointer where the pointee was not captured: + + T\* p = new T; + + { // Captured variable name: "p", type: "T*", value: "0x00400400" + status { is_error: true, description { format: "unavailable" } } + } + + The status should describe the reason for the missing value, such as + ````, ````, + ````. + + Note that a null pointer should not have members. + + 5) An unnamed value: + + int\* p = new int(7); + + { // Captured variable name: "p", value: "0x00500500", type: + "int*", members { value: "7", type: "int" } } + + 6) An unnamed pointer where the pointee was not captured: + + int\* p = new int(7); int*\* pp = &p; + + { // Captured variable name: "pp", value: "0x00500500", type: + "int**", members { value: "0x00400400", type: "int*" status { + is_error: true, description: { format: "unavailable" } } } } } + + To optimize computation, memory and network traffic, variables that + repeat in the output multiple times can be stored once in a shared + variable table and be referenced using the ``var_table_index`` + field. The variables stored in the shared table are nameless and are + essentially a partition of the complete variable. To reconstruct the + complete variable, merge the referencing variable with the + referenced variable. + + When using the shared variable table, the following variables: + + :: + + T x = { 3, 7 }; + T* p = &x; + T& r = x; + + { name: "x", var_table_index: 3, type: "T" } // Captured variables + { name: "p", value "0x00500500", type="T*", var_table_index: 3 } + { name: "r", type="T&", var_table_index: 3 } + + { // Shared variable table entry #3: + members { name: "m1", value: "3", type: "int" }, + members { name: "m2", value: "7", type: "int" } + } + + Note that the pointer address is stored with the referencing + variable and not with the referenced variable. This allows the + referenced variable to be shared between pointers and references. + + The type field is optional. The debugger agent may or may not + support it. + + Attributes: + name (str): + Name of the variable, if any. + value (str): + Simple value of the variable. + type_ (str): + Variable type (e.g. ``MyClass``). If the variable is split + with ``var_table_index``, ``type`` goes next to ``value``. + The interpretation of a type is agent specific. It is + recommended to include the dynamic type rather than a static + type of an object. + members (Sequence[google.cloud.debugger_v2.types.Variable]): + Members contained or pointed to by the + variable. + var_table_index (google.protobuf.wrappers_pb2.Int32Value): + Reference to a variable in the shared variable table. More + than one variable can reference the same variable in the + table. The ``var_table_index`` field is an index into + ``variable_table`` in Breakpoint. + status (google.cloud.debugger_v2.types.StatusMessage): + Status associated with the variable. This field will usually + stay unset. A status of a single variable only applies to + that variable or expression. The rest of breakpoint data + still remains valid. Variables might be reported in error + state even when breakpoint is not in final state. + + The message may refer to variable name with ``refers_to`` + set to ``VARIABLE_NAME``. Alternatively ``refers_to`` will + be set to ``VARIABLE_VALUE``. In either case variable value + and members will be unset. + + Example of error message applied to name: + ``Invalid expression syntax``. + + Example of information message applied to value: + ``Not captured``. + + Examples of error message applied to value: + + - ``Malformed string``, + - ``Field f not found in class C`` + - ``Null pointer dereference`` + """ + + name = proto.Field( + proto.STRING, + number=1, + ) + value = proto.Field( + proto.STRING, + number=2, + ) + type_ = proto.Field( + proto.STRING, + number=6, + ) + members = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='Variable', + ) + var_table_index = proto.Field( + proto.MESSAGE, + number=4, + message=wrappers_pb2.Int32Value, + ) + status = proto.Field( + proto.MESSAGE, + number=5, + message='StatusMessage', + ) + + +class StackFrame(proto.Message): + r"""Represents a stack frame context. + + Attributes: + function (str): + Demangled function name at the call site. + location (google.cloud.debugger_v2.types.SourceLocation): + Source location of the call site. + arguments (Sequence[google.cloud.debugger_v2.types.Variable]): + Set of arguments passed to this function. + Note that this might not be populated for all + stack frames. + locals_ (Sequence[google.cloud.debugger_v2.types.Variable]): + Set of local variables at the stack frame + location. Note that this might not be populated + for all stack frames. + """ + + function = proto.Field( + proto.STRING, + number=1, + ) + location = proto.Field( + proto.MESSAGE, + number=2, + message='SourceLocation', + ) + arguments = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='Variable', + ) + locals_ = proto.RepeatedField( + proto.MESSAGE, + number=4, + message='Variable', + ) + + +class Breakpoint(proto.Message): + r"""Represents the breakpoint specification, status and results. + + Attributes: + id (str): + Breakpoint identifier, unique in the scope of + the debuggee. + action (google.cloud.debugger_v2.types.Breakpoint.Action): + Action that the agent should perform when the + code at the breakpoint location is hit. + location (google.cloud.debugger_v2.types.SourceLocation): + Breakpoint source location. + condition (str): + Condition that triggers the breakpoint. + The condition is a compound boolean expression + composed using expressions in a programming + language at the source location. + expressions (Sequence[str]): + List of read-only expressions to evaluate at the breakpoint + location. The expressions are composed using expressions in + the programming language at the source location. If the + breakpoint action is ``LOG``, the evaluated expressions are + included in log statements. + log_message_format (str): + Only relevant when action is ``LOG``. Defines the message to + log when the breakpoint hits. The message may include + parameter placeholders ``$0``, ``$1``, etc. These + placeholders are replaced with the evaluated value of the + appropriate expression. Expressions not referenced in + ``log_message_format`` are not logged. + + Example: ``Message received, id = $0, count = $1`` with + ``expressions`` = ``[ message.id, message.count ]``. + log_level (google.cloud.debugger_v2.types.Breakpoint.LogLevel): + Indicates the severity of the log. Only relevant when action + is ``LOG``. + is_final_state (bool): + When true, indicates that this is a final + result and the breakpoint state will not change + from here on. + create_time (google.protobuf.timestamp_pb2.Timestamp): + Time this breakpoint was created by the + server in seconds resolution. + final_time (google.protobuf.timestamp_pb2.Timestamp): + Time this breakpoint was finalized as seen by + the server in seconds resolution. + user_email (str): + E-mail address of the user that created this + breakpoint + status (google.cloud.debugger_v2.types.StatusMessage): + Breakpoint status. + + The status includes an error flag and a human readable + message. This field is usually unset. The message can be + either informational or an error message. Regardless, + clients should always display the text message back to the + user. + + Error status indicates complete failure of the breakpoint. + + Example (non-final state): ``Still loading symbols...`` + + Examples (final state): + + - ``Invalid line number`` referring to location + - ``Field f not found in class C`` referring to condition + stack_frames (Sequence[google.cloud.debugger_v2.types.StackFrame]): + The stack at breakpoint time, where stack_frames[0] + represents the most recently entered function. + evaluated_expressions (Sequence[google.cloud.debugger_v2.types.Variable]): + Values of evaluated expressions at breakpoint time. The + evaluated expressions appear in exactly the same order they + are listed in the ``expressions`` field. The ``name`` field + holds the original expression text, the ``value`` or + ``members`` field holds the result of the evaluated + expression. If the expression cannot be evaluated, the + ``status`` inside the ``Variable`` will indicate an error + and contain the error text. + variable_table (Sequence[google.cloud.debugger_v2.types.Variable]): + The ``variable_table`` exists to aid with computation, + memory and network traffic optimization. It enables storing + a variable once and reference it from multiple variables, + including variables stored in the ``variable_table`` itself. + For example, the same ``this`` object, which may appear at + many levels of the stack, can have all of its data stored + once in this table. The stack frame variables then would + hold only a reference to it. + + The variable ``var_table_index`` field is an index into this + repeated field. The stored objects are nameless and get + their name from the referencing variable. The effective + variable is a merge of the referencing variable and the + referenced variable. + labels (Sequence[google.cloud.debugger_v2.types.Breakpoint.LabelsEntry]): + A set of custom breakpoint properties, + populated by the agent, to be displayed to the + user. + """ + class Action(proto.Enum): + r"""Actions that can be taken when a breakpoint hits. + Agents should reject breakpoints with unsupported or unknown + action values. + """ + CAPTURE = 0 + LOG = 1 + + class LogLevel(proto.Enum): + r"""Log severity levels.""" + INFO = 0 + WARNING = 1 + ERROR = 2 + + id = proto.Field( + proto.STRING, + number=1, + ) + action = proto.Field( + proto.ENUM, + number=13, + enum=Action, + ) + location = proto.Field( + proto.MESSAGE, + number=2, + message='SourceLocation', + ) + condition = proto.Field( + proto.STRING, + number=3, + ) + expressions = proto.RepeatedField( + proto.STRING, + number=4, + ) + log_message_format = proto.Field( + proto.STRING, + number=14, + ) + log_level = proto.Field( + proto.ENUM, + number=15, + enum=LogLevel, + ) + is_final_state = proto.Field( + proto.BOOL, + number=5, + ) + create_time = proto.Field( + proto.MESSAGE, + number=11, + message=timestamp_pb2.Timestamp, + ) + final_time = proto.Field( + proto.MESSAGE, + number=12, + message=timestamp_pb2.Timestamp, + ) + user_email = proto.Field( + proto.STRING, + number=16, + ) + status = proto.Field( + proto.MESSAGE, + number=10, + message='StatusMessage', + ) + stack_frames = proto.RepeatedField( + proto.MESSAGE, + number=7, + message='StackFrame', + ) + evaluated_expressions = proto.RepeatedField( + proto.MESSAGE, + number=8, + message='Variable', + ) + variable_table = proto.RepeatedField( + proto.MESSAGE, + number=9, + message='Variable', + ) + labels = proto.MapField( + proto.STRING, + proto.STRING, + number=17, + ) + + +class Debuggee(proto.Message): + r"""Represents the debugged application. The application may + include one or more replicated processes executing the same + code. Each of these processes is attached with a debugger agent, + carrying out the debugging commands. Agents attached to the same + debuggee identify themselves as such by using exactly the same + Debuggee message value when registering. + + Attributes: + id (str): + Unique identifier for the debuggee generated + by the controller service. + project (str): + Project the debuggee is associated with. + Use project number or id when registering a + Google Cloud Platform project. + uniquifier (str): + Uniquifier to further distinguish the + application. It is possible that different + applications might have identical values in the + debuggee message, thus, incorrectly identified + as a single application by the Controller + service. This field adds salt to further + distinguish the application. Agents should + consider seeding this field with value that + identifies the code, binary, configuration and + environment. + description (str): + Human readable description of the debuggee. + Including a human-readable project name, + environment name and version information is + recommended. + is_inactive (bool): + If set to ``true``, indicates that Controller service does + not detect any activity from the debuggee agents and the + application is possibly stopped. + agent_version (str): + Version ID of the agent. Schema: + ``domain/language-platform/vmajor.minor`` (for example + ``google.com/java-gcp/v1.1``). + is_disabled (bool): + If set to ``true``, indicates that the agent should disable + itself and detach from the debuggee. + status (google.cloud.debugger_v2.types.StatusMessage): + Human readable message to be displayed to the + user about this debuggee. Absence of this field + indicates no status. The message can be either + informational or an error status. + source_contexts (Sequence[google.devtools.source.v1.source_context_pb2.SourceContext]): + References to the locations and revisions of + the source code used in the deployed + application. + ext_source_contexts (Sequence[google.devtools.source.v1.source_context_pb2.ExtendedSourceContext]): + References to the locations and revisions of + the source code used in the deployed + application. + labels (Sequence[google.cloud.debugger_v2.types.Debuggee.LabelsEntry]): + A set of custom debuggee properties, + populated by the agent, to be displayed to the + user. + """ + + id = proto.Field( + proto.STRING, + number=1, + ) + project = proto.Field( + proto.STRING, + number=2, + ) + uniquifier = proto.Field( + proto.STRING, + number=3, + ) + description = proto.Field( + proto.STRING, + number=4, + ) + is_inactive = proto.Field( + proto.BOOL, + number=5, + ) + agent_version = proto.Field( + proto.STRING, + number=6, + ) + is_disabled = proto.Field( + proto.BOOL, + number=7, + ) + status = proto.Field( + proto.MESSAGE, + number=8, + message='StatusMessage', + ) + source_contexts = proto.RepeatedField( + proto.MESSAGE, + number=9, + message=source_context_pb2.SourceContext, + ) + ext_source_contexts = proto.RepeatedField( + proto.MESSAGE, + number=13, + message=source_context_pb2.ExtendedSourceContext, + ) + labels = proto.MapField( + proto.STRING, + proto.STRING, + number=11, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py b/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py new file mode 100644 index 0000000..47fea00 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py @@ -0,0 +1,311 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import proto # type: ignore + +from google.cloud.debugger_v2.types import data + + +__protobuf__ = proto.module( + package='google.devtools.clouddebugger.v2', + manifest={ + 'SetBreakpointRequest', + 'SetBreakpointResponse', + 'GetBreakpointRequest', + 'GetBreakpointResponse', + 'DeleteBreakpointRequest', + 'ListBreakpointsRequest', + 'ListBreakpointsResponse', + 'ListDebuggeesRequest', + 'ListDebuggeesResponse', + }, +) + + +class SetBreakpointRequest(proto.Message): + r"""Request to set a breakpoint + + Attributes: + debuggee_id (str): + Required. ID of the debuggee where the + breakpoint is to be set. + breakpoint_ (google.cloud.debugger_v2.types.Breakpoint): + Required. Breakpoint specification to set. The field + ``location`` of the breakpoint must be set. + client_version (str): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., ``google.com/intellij/v1``). + """ + + debuggee_id = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_ = proto.Field( + proto.MESSAGE, + number=2, + message=data.Breakpoint, + ) + client_version = proto.Field( + proto.STRING, + number=4, + ) + + +class SetBreakpointResponse(proto.Message): + r"""Response for setting a breakpoint. + + Attributes: + breakpoint_ (google.cloud.debugger_v2.types.Breakpoint): + Breakpoint resource. The field ``id`` is guaranteed to be + set (in addition to the echoed fileds). + """ + + breakpoint_ = proto.Field( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + + +class GetBreakpointRequest(proto.Message): + r"""Request to get breakpoint information. + + Attributes: + debuggee_id (str): + Required. ID of the debuggee whose breakpoint + to get. + breakpoint_id (str): + Required. ID of the breakpoint to get. + client_version (str): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., ``google.com/intellij/v1``). + """ + + debuggee_id = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_id = proto.Field( + proto.STRING, + number=2, + ) + client_version = proto.Field( + proto.STRING, + number=4, + ) + + +class GetBreakpointResponse(proto.Message): + r"""Response for getting breakpoint information. + + Attributes: + breakpoint_ (google.cloud.debugger_v2.types.Breakpoint): + Complete breakpoint state. The fields ``id`` and + ``location`` are guaranteed to be set. + """ + + breakpoint_ = proto.Field( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + + +class DeleteBreakpointRequest(proto.Message): + r"""Request to delete a breakpoint. + + Attributes: + debuggee_id (str): + Required. ID of the debuggee whose breakpoint + to delete. + breakpoint_id (str): + Required. ID of the breakpoint to delete. + client_version (str): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., ``google.com/intellij/v1``). + """ + + debuggee_id = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_id = proto.Field( + proto.STRING, + number=2, + ) + client_version = proto.Field( + proto.STRING, + number=3, + ) + + +class ListBreakpointsRequest(proto.Message): + r"""Request to list breakpoints. + + Attributes: + debuggee_id (str): + Required. ID of the debuggee whose + breakpoints to list. + include_all_users (bool): + When set to ``true``, the response includes the list of + breakpoints set by any user. Otherwise, it includes only + breakpoints set by the caller. + include_inactive (bool): + When set to ``true``, the response includes active and + inactive breakpoints. Otherwise, it includes only active + breakpoints. + action (google.cloud.debugger_v2.types.ListBreakpointsRequest.BreakpointActionValue): + When set, the response includes only + breakpoints with the specified action. + strip_results (bool): + This field is deprecated. The following fields are always + stripped out of the result: ``stack_frames``, + ``evaluated_expressions`` and ``variable_table``. + wait_token (str): + A wait token that, if specified, blocks the call until the + breakpoints list has changed, or a server selected timeout + has expired. The value should be set from the last response. + The error code ``google.rpc.Code.ABORTED`` (RPC) is returned + on wait timeout, which should be called again with the same + ``wait_token``. + client_version (str): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., ``google.com/intellij/v1``). + """ + + class BreakpointActionValue(proto.Message): + r"""Wrapper message for ``Breakpoint.Action``. Defines a filter on the + action field of breakpoints. + + Attributes: + value (google.cloud.debugger_v2.types.Breakpoint.Action): + Only breakpoints with the specified action + will pass the filter. + """ + + value = proto.Field( + proto.ENUM, + number=1, + enum=data.Breakpoint.Action, + ) + + debuggee_id = proto.Field( + proto.STRING, + number=1, + ) + include_all_users = proto.Field( + proto.BOOL, + number=2, + ) + include_inactive = proto.Field( + proto.BOOL, + number=3, + ) + action = proto.Field( + proto.MESSAGE, + number=4, + message=BreakpointActionValue, + ) + strip_results = proto.Field( + proto.BOOL, + number=5, + ) + wait_token = proto.Field( + proto.STRING, + number=6, + ) + client_version = proto.Field( + proto.STRING, + number=8, + ) + + +class ListBreakpointsResponse(proto.Message): + r"""Response for listing breakpoints. + + Attributes: + breakpoints (Sequence[google.cloud.debugger_v2.types.Breakpoint]): + List of breakpoints matching the request. The fields ``id`` + and ``location`` are guaranteed to be set on each + breakpoint. The fields: ``stack_frames``, + ``evaluated_expressions`` and ``variable_table`` are cleared + on each breakpoint regardless of its status. + next_wait_token (str): + A wait token that can be used in the next call to ``list`` + (REST) or ``ListBreakpoints`` (RPC) to block until the list + of breakpoints has changes. + """ + + breakpoints = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + next_wait_token = proto.Field( + proto.STRING, + number=2, + ) + + +class ListDebuggeesRequest(proto.Message): + r"""Request to list debuggees. + + Attributes: + project (str): + Required. Project number of a Google Cloud + project whose debuggees to list. + include_inactive (bool): + When set to ``true``, the result includes all debuggees. + Otherwise, the result includes only debuggees that are + active. + client_version (str): + Required. The client version making the call. Schema: + ``domain/type/version`` (e.g., ``google.com/intellij/v1``). + """ + + project = proto.Field( + proto.STRING, + number=2, + ) + include_inactive = proto.Field( + proto.BOOL, + number=3, + ) + client_version = proto.Field( + proto.STRING, + number=4, + ) + + +class ListDebuggeesResponse(proto.Message): + r"""Response for listing debuggees. + + Attributes: + debuggees (Sequence[google.cloud.debugger_v2.types.Debuggee]): + List of debuggees accessible to the calling user. The fields + ``debuggee.id`` and ``description`` are guaranteed to be + set. The ``description`` field is a human readable field + provided by agents and can be displayed to users. + """ + + debuggees = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Debuggee, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v2/mypy.ini b/owl-bot-staging/v2/mypy.ini new file mode 100644 index 0000000..4505b48 --- /dev/null +++ b/owl-bot-staging/v2/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.6 +namespace_packages = True diff --git a/owl-bot-staging/v2/noxfile.py b/owl-bot-staging/v2/noxfile.py new file mode 100644 index 0000000..0a0ac5a --- /dev/null +++ b/owl-bot-staging/v2/noxfile.py @@ -0,0 +1,132 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import os +import pathlib +import shutil +import subprocess +import sys + + +import nox # type: ignore + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") + + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", +] + +@nox.session(python=['3.6', '3.7', '3.8', '3.9', '3.10']) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/debugger_v2/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python='3.9') +def cover(session): + """Run the final coverage report. + This outputs the coverage report aggregating coverage from the unit + test runs (not system test runs), and then erases coverage data. + """ + session.install("coverage", "pytest-cov") + session.run("coverage", "report", "--show-missing", "--fail-under=100") + + session.run("coverage", "erase") + + +@nox.session(python=['3.6', '3.7', '3.8', '3.9']) +def mypy(session): + """Run the type checker.""" + session.install('mypy', 'types-pkg_resources') + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + + +@nox.session +def update_lower_bounds(session): + """Update lower bounds in constraints.txt to match setup.py""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'update', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + + +@nox.session +def check_lower_bounds(session): + """Check lower bounds in setup.py are reflected in constraints file""" + session.install('google-cloud-testutils') + session.install('.') + + session.run( + 'lower-bound-checker', + 'check', + '--package-name', + PACKAGE_NAME, + '--constraints-file', + str(LOWER_BOUND_CONSTRAINTS_FILE), + ) + +@nox.session(python='3.9') +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx==4.0.1", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) diff --git a/owl-bot-staging/v2/scripts/fixup_debugger_v2_keywords.py b/owl-bot-staging/v2/scripts/fixup_debugger_v2_keywords.py new file mode 100644 index 0000000..0f21424 --- /dev/null +++ b/owl-bot-staging/v2/scripts/fixup_debugger_v2_keywords.py @@ -0,0 +1,183 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class debuggerCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'delete_breakpoint': ('debuggee_id', 'breakpoint_id', 'client_version', ), + 'get_breakpoint': ('debuggee_id', 'breakpoint_id', 'client_version', ), + 'list_active_breakpoints': ('debuggee_id', 'wait_token', 'success_on_timeout', ), + 'list_breakpoints': ('debuggee_id', 'client_version', 'include_all_users', 'include_inactive', 'action', 'strip_results', 'wait_token', ), + 'list_debuggees': ('project', 'client_version', 'include_inactive', ), + 'register_debuggee': ('debuggee', ), + 'set_breakpoint': ('debuggee_id', 'breakpoint_', 'client_version', ), + 'update_active_breakpoint': ('debuggee_id', 'breakpoint_', ), + } + + def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: + try: + key = original.func.attr.value + kword_params = self.METHOD_TO_PARAMS[key] + except (AttributeError, KeyError): + # Either not a method from the API or too convoluted to be sure. + return updated + + # If the existing code is valid, keyword args come after positional args. + # Therefore, all positional args must map to the first parameters. + args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) + if any(k.keyword.value == "request" for k in kwargs): + # We've already fixed this file, don't fix it again. + return updated + + kwargs, ctrl_kwargs = partition( + lambda a: a.keyword.value not in self.CTRL_PARAMS, + kwargs + ) + + args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] + ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) + for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) + + request_arg = cst.Arg( + value=cst.Dict([ + cst.DictElement( + cst.SimpleString("'{}'".format(name)), +cst.Element(value=arg.value) + ) + # Note: the args + kwargs looks silly, but keep in mind that + # the control parameters had to be stripped out, and that + # those could have been passed positionally or by keyword. + for name, arg in zip(kword_params, args + kwargs)]), + keyword=cst.Name("request") + ) + + return updated.with_changes( + args=[request_arg] + ctrl_kwargs + ) + + +def fix_files( + in_dir: pathlib.Path, + out_dir: pathlib.Path, + *, + transformer=debuggerCallTransformer(), +): + """Duplicate the input dir to the output dir, fixing file method calls. + + Preconditions: + * in_dir is a real directory + * out_dir is a real, empty directory + """ + pyfile_gen = ( + pathlib.Path(os.path.join(root, f)) + for root, _, files in os.walk(in_dir) + for f in files if os.path.splitext(f)[1] == ".py" + ) + + for fpath in pyfile_gen: + with open(fpath, 'r') as f: + src = f.read() + + # Parse the code and insert method call fixes. + tree = cst.parse_module(src) + updated = tree.visit(transformer) + + # Create the path and directory structure for the new file. + updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) + updated_path.parent.mkdir(parents=True, exist_ok=True) + + # Generate the updated source file at the corresponding path. + with open(updated_path, 'w') as f: + f.write(updated.code) + + +if __name__ == '__main__': + parser = argparse.ArgumentParser( + description="""Fix up source that uses the debugger client library. + +The existing sources are NOT overwritten but are copied to output_dir with changes made. + +Note: This tool operates at a best-effort level at converting positional + parameters in client method calls to keyword based parameters. + Cases where it WILL FAIL include + A) * or ** expansion in a method call. + B) Calls via function or method alias (includes free function calls) + C) Indirect or dispatched calls (e.g. the method is looked up dynamically) + + These all constitute false negatives. The tool will also detect false + positives when an API method shares a name with another method. +""") + parser.add_argument( + '-d', + '--input-directory', + required=True, + dest='input_dir', + help='the input directory to walk for python files to fix up', + ) + parser.add_argument( + '-o', + '--output-directory', + required=True, + dest='output_dir', + help='the directory to output files fixed via un-flattening', + ) + args = parser.parse_args() + input_dir = pathlib.Path(args.input_dir) + output_dir = pathlib.Path(args.output_dir) + if not input_dir.is_dir(): + print( + f"input directory '{input_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if not output_dir.is_dir(): + print( + f"output directory '{output_dir}' does not exist or is not a directory", + file=sys.stderr, + ) + sys.exit(-1) + + if os.listdir(output_dir): + print( + f"output directory '{output_dir}' is not empty", + file=sys.stderr, + ) + sys.exit(-1) + + fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v2/setup.py b/owl-bot-staging/v2/setup.py new file mode 100644 index 0000000..862ef17 --- /dev/null +++ b/owl-bot-staging/v2/setup.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import io +import os +import setuptools # type: ignore + +version = '0.1.0' + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, 'README.rst') +with io.open(readme_filename, encoding='utf-8') as readme_file: + readme = readme_file.read() + +setuptools.setup( + name='google-cloud-debugger-client', + version=version, + long_description=readme, + packages=setuptools.PEP420PackageFinder.find(), + namespace_packages=('google', 'google.cloud'), + platforms='Posix; MacOS X; Windows', + include_package_data=True, + install_requires=( + 'google-api-core[grpc] >= 1.28.0, < 3.0.0dev', + 'libcst >= 0.2.5', + 'proto-plus >= 1.19.7', + ), + python_requires='>=3.6', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Topic :: Internet', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], + zip_safe=False, +) diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v2/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# diff --git a/owl-bot-staging/v2/tests/unit/__init__.py b/owl-bot-staging/v2/tests/unit/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# diff --git a/owl-bot-staging/v2/tests/unit/gapic/__init__.py b/owl-bot-staging/v2/tests/unit/gapic/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# diff --git a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py new file mode 100644 index 0000000..b54a5fc --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# diff --git a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py new file mode 100644 index 0000000..711b7b7 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py @@ -0,0 +1,1580 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import os +import mock + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.debugger_v2.services.controller2 import Controller2AsyncClient +from google.cloud.debugger_v2.services.controller2 import Controller2Client +from google.cloud.debugger_v2.services.controller2 import transports +from google.cloud.debugger_v2.types import controller +from google.cloud.debugger_v2.types import data +from google.devtools.source.v1 import source_context_pb2 # type: ignore +from google.oauth2 import service_account +from google.protobuf import timestamp_pb2 # type: ignore +from google.protobuf import wrappers_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert Controller2Client._get_default_mtls_endpoint(None) is None + assert Controller2Client._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert Controller2Client._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert Controller2Client._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert Controller2Client._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert Controller2Client._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + Controller2Client, + Controller2AsyncClient, +]) +def test_controller2_client_from_service_account_info(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'clouddebugger.googleapis.com:443' + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.Controller2GrpcTransport, "grpc"), + (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_controller2_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class", [ + Controller2Client, + Controller2AsyncClient, +]) +def test_controller2_client_from_service_account_file(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'clouddebugger.googleapis.com:443' + + +def test_controller2_client_get_transport_class(): + transport = Controller2Client.get_transport_class() + available_transports = [ + transports.Controller2GrpcTransport, + ] + assert transport in available_transports + + transport = Controller2Client.get_transport_class("grpc") + assert transport == transports.Controller2GrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (Controller2Client, transports.Controller2GrpcTransport, "grpc"), + (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(Controller2Client, "DEFAULT_ENDPOINT", modify_default_endpoint(Controller2Client)) +@mock.patch.object(Controller2AsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(Controller2AsyncClient)) +def test_controller2_client_client_options(client_class, transport_class, transport_name): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(Controller2Client, 'get_transport_class') as gtc: + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(Controller2Client, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (Controller2Client, transports.Controller2GrpcTransport, "grpc", "true"), + (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", "true"), + (Controller2Client, transports.Controller2GrpcTransport, "grpc", "false"), + (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(Controller2Client, "DEFAULT_ENDPOINT", modify_default_endpoint(Controller2Client)) +@mock.patch.object(Controller2AsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(Controller2AsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_controller2_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize("client_class", [ + Controller2Client, Controller2AsyncClient +]) +@mock.patch.object(Controller2Client, "DEFAULT_ENDPOINT", modify_default_endpoint(Controller2Client)) +@mock.patch.object(Controller2AsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(Controller2AsyncClient)) +def test_controller2_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (Controller2Client, transports.Controller2GrpcTransport, "grpc"), + (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_controller2_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (Controller2Client, transports.Controller2GrpcTransport, "grpc", grpc_helpers), + (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_controller2_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + +def test_controller2_client_client_options_from_dict(): + with mock.patch('google.cloud.debugger_v2.services.controller2.transports.Controller2GrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = Controller2Client( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (Controller2Client, transports.Controller2GrpcTransport, "grpc", grpc_helpers), + (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_controller2_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "clouddebugger.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/cloud_debugger', +), + scopes=None, + default_host="clouddebugger.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + controller.RegisterDebuggeeRequest, + dict, +]) +def test_register_debuggee(request_type, transport: str = 'grpc'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_debuggee), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = controller.RegisterDebuggeeResponse( + ) + response = client.register_debuggee(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == controller.RegisterDebuggeeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.RegisterDebuggeeResponse) + + +def test_register_debuggee_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_debuggee), + '__call__') as call: + client.register_debuggee() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == controller.RegisterDebuggeeRequest() + + +@pytest.mark.asyncio +async def test_register_debuggee_async(transport: str = 'grpc_asyncio', request_type=controller.RegisterDebuggeeRequest): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_debuggee), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(controller.RegisterDebuggeeResponse( + )) + response = await client.register_debuggee(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == controller.RegisterDebuggeeRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.RegisterDebuggeeResponse) + + +@pytest.mark.asyncio +async def test_register_debuggee_async_from_dict(): + await test_register_debuggee_async(request_type=dict) + + +def test_register_debuggee_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_debuggee), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = controller.RegisterDebuggeeResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.register_debuggee( + debuggee=data.Debuggee(id='id_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee + mock_val = data.Debuggee(id='id_value') + assert arg == mock_val + + +def test_register_debuggee_flattened_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.register_debuggee( + controller.RegisterDebuggeeRequest(), + debuggee=data.Debuggee(id='id_value'), + ) + + +@pytest.mark.asyncio +async def test_register_debuggee_flattened_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.register_debuggee), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = controller.RegisterDebuggeeResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.RegisterDebuggeeResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.register_debuggee( + debuggee=data.Debuggee(id='id_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee + mock_val = data.Debuggee(id='id_value') + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_register_debuggee_flattened_error_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.register_debuggee( + controller.RegisterDebuggeeRequest(), + debuggee=data.Debuggee(id='id_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + controller.ListActiveBreakpointsRequest, + dict, +]) +def test_list_active_breakpoints(request_type, transport: str = 'grpc'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_active_breakpoints), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = controller.ListActiveBreakpointsResponse( + next_wait_token='next_wait_token_value', + wait_expired=True, + ) + response = client.list_active_breakpoints(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == controller.ListActiveBreakpointsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.ListActiveBreakpointsResponse) + assert response.next_wait_token == 'next_wait_token_value' + assert response.wait_expired is True + + +def test_list_active_breakpoints_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_active_breakpoints), + '__call__') as call: + client.list_active_breakpoints() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == controller.ListActiveBreakpointsRequest() + + +@pytest.mark.asyncio +async def test_list_active_breakpoints_async(transport: str = 'grpc_asyncio', request_type=controller.ListActiveBreakpointsRequest): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_active_breakpoints), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse( + next_wait_token='next_wait_token_value', + wait_expired=True, + )) + response = await client.list_active_breakpoints(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == controller.ListActiveBreakpointsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.ListActiveBreakpointsResponse) + assert response.next_wait_token == 'next_wait_token_value' + assert response.wait_expired is True + + +@pytest.mark.asyncio +async def test_list_active_breakpoints_async_from_dict(): + await test_list_active_breakpoints_async(request_type=dict) + + +def test_list_active_breakpoints_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_active_breakpoints), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = controller.ListActiveBreakpointsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_active_breakpoints( + debuggee_id='debuggee_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee_id + mock_val = 'debuggee_id_value' + assert arg == mock_val + + +def test_list_active_breakpoints_flattened_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_active_breakpoints( + controller.ListActiveBreakpointsRequest(), + debuggee_id='debuggee_id_value', + ) + + +@pytest.mark.asyncio +async def test_list_active_breakpoints_flattened_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_active_breakpoints), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = controller.ListActiveBreakpointsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_active_breakpoints( + debuggee_id='debuggee_id_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee_id + mock_val = 'debuggee_id_value' + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_list_active_breakpoints_flattened_error_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_active_breakpoints( + controller.ListActiveBreakpointsRequest(), + debuggee_id='debuggee_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + controller.UpdateActiveBreakpointRequest, + dict, +]) +def test_update_active_breakpoint(request_type, transport: str = 'grpc'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_active_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = controller.UpdateActiveBreakpointResponse( + ) + response = client.update_active_breakpoint(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == controller.UpdateActiveBreakpointRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.UpdateActiveBreakpointResponse) + + +def test_update_active_breakpoint_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_active_breakpoint), + '__call__') as call: + client.update_active_breakpoint() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == controller.UpdateActiveBreakpointRequest() + + +@pytest.mark.asyncio +async def test_update_active_breakpoint_async(transport: str = 'grpc_asyncio', request_type=controller.UpdateActiveBreakpointRequest): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_active_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse( + )) + response = await client.update_active_breakpoint(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == controller.UpdateActiveBreakpointRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.UpdateActiveBreakpointResponse) + + +@pytest.mark.asyncio +async def test_update_active_breakpoint_async_from_dict(): + await test_update_active_breakpoint_async(request_type=dict) + + +def test_update_active_breakpoint_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_active_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = controller.UpdateActiveBreakpointResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_active_breakpoint( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee_id + mock_val = 'debuggee_id_value' + assert arg == mock_val + arg = args[0].breakpoint_ + mock_val = data.Breakpoint(id='id_value') + assert arg == mock_val + + +def test_update_active_breakpoint_flattened_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.update_active_breakpoint( + controller.UpdateActiveBreakpointRequest(), + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + ) + + +@pytest.mark.asyncio +async def test_update_active_breakpoint_flattened_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_active_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = controller.UpdateActiveBreakpointResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_active_breakpoint( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee_id + mock_val = 'debuggee_id_value' + assert arg == mock_val + arg = args[0].breakpoint_ + mock_val = data.Breakpoint(id='id_value') + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_update_active_breakpoint_flattened_error_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.update_active_breakpoint( + controller.UpdateActiveBreakpointRequest(), + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.Controller2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.Controller2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = Controller2Client( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.Controller2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = Controller2Client( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = Controller2Client( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.Controller2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = Controller2Client( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.Controller2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = Controller2Client(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.Controller2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.Controller2GrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.Controller2GrpcTransport, + transports.Controller2GrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.Controller2GrpcTransport, + ) + +def test_controller2_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.Controller2Transport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_controller2_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.debugger_v2.services.controller2.transports.Controller2Transport.__init__') as Transport: + Transport.return_value = None + transport = transports.Controller2Transport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'register_debuggee', + 'list_active_breakpoints', + 'update_active_breakpoint', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + +def test_controller2_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.debugger_v2.services.controller2.transports.Controller2Transport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.Controller2Transport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/cloud_debugger', +), + quota_project_id="octopus", + ) + + +def test_controller2_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.debugger_v2.services.controller2.transports.Controller2Transport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.Controller2Transport() + adc.assert_called_once() + + +def test_controller2_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + Controller2Client() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/cloud_debugger', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.Controller2GrpcTransport, + transports.Controller2GrpcAsyncIOTransport, + ], +) +def test_controller2_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud_debugger',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.Controller2GrpcTransport, grpc_helpers), + (transports.Controller2GrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_controller2_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "clouddebugger.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/cloud_debugger', +), + scopes=["1", "2"], + default_host="clouddebugger.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.Controller2GrpcTransport, transports.Controller2GrpcAsyncIOTransport]) +def test_controller2_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + + +def test_controller2_host_no_port(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), + ) + assert client.transport._host == 'clouddebugger.googleapis.com:443' + + +def test_controller2_host_with_port(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), + ) + assert client.transport._host == 'clouddebugger.googleapis.com:8000' + +def test_controller2_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.Controller2GrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_controller2_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.Controller2GrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.Controller2GrpcTransport, transports.Controller2GrpcAsyncIOTransport]) +def test_controller2_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.Controller2GrpcTransport, transports.Controller2GrpcAsyncIOTransport]) +def test_controller2_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = Controller2Client.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = Controller2Client.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = Controller2Client.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = Controller2Client.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = Controller2Client.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = Controller2Client.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = Controller2Client.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = Controller2Client.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = Controller2Client.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = Controller2Client.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = Controller2Client.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = Controller2Client.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "winkle" + location = "nautilus" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = Controller2Client.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = Controller2Client.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = Controller2Client.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.Controller2Transport, '_prep_wrapped_messages') as prep: + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.Controller2Transport, '_prep_wrapped_messages') as prep: + transport_class = Controller2Client.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'grpc', + ] + for transport in transports: + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (Controller2Client, transports.Controller2GrpcTransport), + (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) diff --git a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py new file mode 100644 index 0000000..d506574 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py @@ -0,0 +1,1981 @@ +# -*- coding: utf-8 -*- +# Copyright 2020 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. +# +import os +import mock + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + + +from google.api_core import client_options +from google.api_core import exceptions as core_exceptions +from google.api_core import gapic_v1 +from google.api_core import grpc_helpers +from google.api_core import grpc_helpers_async +from google.api_core import path_template +from google.auth import credentials as ga_credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.debugger_v2.services.debugger2 import Debugger2AsyncClient +from google.cloud.debugger_v2.services.debugger2 import Debugger2Client +from google.cloud.debugger_v2.services.debugger2 import transports +from google.cloud.debugger_v2.types import data +from google.cloud.debugger_v2.types import debugger +from google.oauth2 import service_account +from google.protobuf import timestamp_pb2 # type: ignore +from google.protobuf import wrappers_pb2 # type: ignore +import google.auth + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert Debugger2Client._get_default_mtls_endpoint(None) is None + assert Debugger2Client._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert Debugger2Client._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert Debugger2Client._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert Debugger2Client._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert Debugger2Client._get_default_mtls_endpoint(non_googleapi) == non_googleapi + + +@pytest.mark.parametrize("client_class", [ + Debugger2Client, + Debugger2AsyncClient, +]) +def test_debugger2_client_from_service_account_info(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'clouddebugger.googleapis.com:443' + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.Debugger2GrpcTransport, "grpc"), + (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_debugger2_client_service_account_always_use_jwt(transport_class, transport_name): + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=True) + use_jwt.assert_called_once_with(True) + + with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: + creds = service_account.Credentials(None, None, None) + transport = transport_class(credentials=creds, always_use_jwt_access=False) + use_jwt.assert_not_called() + + +@pytest.mark.parametrize("client_class", [ + Debugger2Client, + Debugger2AsyncClient, +]) +def test_debugger2_client_from_service_account_file(client_class): + creds = ga_credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'clouddebugger.googleapis.com:443' + + +def test_debugger2_client_get_transport_class(): + transport = Debugger2Client.get_transport_class() + available_transports = [ + transports.Debugger2GrpcTransport, + ] + assert transport in available_transports + + transport = Debugger2Client.get_transport_class("grpc") + assert transport == transports.Debugger2GrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (Debugger2Client, transports.Debugger2GrpcTransport, "grpc"), + (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), +]) +@mock.patch.object(Debugger2Client, "DEFAULT_ENDPOINT", modify_default_endpoint(Debugger2Client)) +@mock.patch.object(Debugger2AsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(Debugger2AsyncClient)) +def test_debugger2_client_client_options(client_class, transport_class, transport_name): + # Check that if channel is provided we won't create a new one. + with mock.patch.object(Debugger2Client, 'get_transport_class') as gtc: + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ) + client = client_class(transport=transport) + gtc.assert_not_called() + + # Check that if channel is provided via str we will create a new one. + with mock.patch.object(Debugger2Client, 'get_transport_class') as gtc: + client = client_class(transport=transport_name) + gtc.assert_called() + + # Check the case api_endpoint is provided. + options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name, client_options=options) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is + # "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_MTLS_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class(transport=transport_name) + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class(transport=transport_name) + + # Check the case quota_project_id is provided + options = client_options.ClientOptions(quota_project_id="octopus") + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ + (Debugger2Client, transports.Debugger2GrpcTransport, "grpc", "true"), + (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", "true"), + (Debugger2Client, transports.Debugger2GrpcTransport, "grpc", "false"), + (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", "false"), +]) +@mock.patch.object(Debugger2Client, "DEFAULT_ENDPOINT", modify_default_endpoint(Debugger2Client)) +@mock.patch.object(Debugger2AsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(Debugger2AsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_debugger2_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): + # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default + # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. + + # Check the case client_cert_source is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # Check the case client_cert_source and ADC client cert are not provided. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): + patched.return_value = None + client = client_class(transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize("client_class", [ + Debugger2Client, Debugger2AsyncClient +]) +@mock.patch.object(Debugger2Client, "DEFAULT_ENDPOINT", modify_default_endpoint(Debugger2Client)) +@mock.patch.object(Debugger2AsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(Debugger2AsyncClient)) +def test_debugger2_client_get_mtls_endpoint_and_cert_source(client_class): + mock_client_cert_source = mock.Mock() + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source == mock_client_cert_source + + # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + mock_client_cert_source = mock.Mock() + mock_api_endpoint = "foo" + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) + assert api_endpoint == mock_api_endpoint + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_ENDPOINT + assert cert_source is None + + # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): + api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() + assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + assert cert_source == mock_client_cert_source + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (Debugger2Client, transports.Debugger2GrpcTransport, "grpc"), + (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_debugger2_client_client_options_scopes(client_class, transport_class, transport_name): + # Check the case scopes are provided. + options = client_options.ClientOptions( + scopes=["1", "2"], + ) + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (Debugger2Client, transports.Debugger2GrpcTransport, "grpc", grpc_helpers), + (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_debugger2_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + +def test_debugger2_client_client_options_from_dict(): + with mock.patch('google.cloud.debugger_v2.services.debugger2.transports.Debugger2GrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = Debugger2Client( + client_options={'api_endpoint': 'squid.clam.whelk'} + ) + grpc_transport.assert_called_once_with( + credentials=None, + credentials_file=None, + host="squid.clam.whelk", + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ + (Debugger2Client, transports.Debugger2GrpcTransport, "grpc", grpc_helpers), + (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_debugger2_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): + # Check the case credentials file is provided. + options = client_options.ClientOptions( + credentials_file="credentials.json" + ) + + with mock.patch.object(transport_class, '__init__') as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "clouddebugger.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/cloud_debugger', +), + scopes=None, + default_host="clouddebugger.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.SetBreakpointRequest, + dict, +]) +def test_set_breakpoint(request_type, transport: str = 'grpc'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = debugger.SetBreakpointResponse( + ) + response = client.set_breakpoint(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.SetBreakpointRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.SetBreakpointResponse) + + +def test_set_breakpoint_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + client.set_breakpoint() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.SetBreakpointRequest() + + +@pytest.mark.asyncio +async def test_set_breakpoint_async(transport: str = 'grpc_asyncio', request_type=debugger.SetBreakpointRequest): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse( + )) + response = await client.set_breakpoint(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.SetBreakpointRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.SetBreakpointResponse) + + +@pytest.mark.asyncio +async def test_set_breakpoint_async_from_dict(): + await test_set_breakpoint_async(request_type=dict) + + +def test_set_breakpoint_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = debugger.SetBreakpointResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.set_breakpoint( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + client_version='client_version_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee_id + mock_val = 'debuggee_id_value' + assert arg == mock_val + arg = args[0].breakpoint_ + mock_val = data.Breakpoint(id='id_value') + assert arg == mock_val + arg = args[0].client_version + mock_val = 'client_version_value' + assert arg == mock_val + + +def test_set_breakpoint_flattened_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.set_breakpoint( + debugger.SetBreakpointRequest(), + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + client_version='client_version_value', + ) + + +@pytest.mark.asyncio +async def test_set_breakpoint_flattened_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = debugger.SetBreakpointResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.set_breakpoint( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + client_version='client_version_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee_id + mock_val = 'debuggee_id_value' + assert arg == mock_val + arg = args[0].breakpoint_ + mock_val = data.Breakpoint(id='id_value') + assert arg == mock_val + arg = args[0].client_version + mock_val = 'client_version_value' + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_set_breakpoint_flattened_error_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.set_breakpoint( + debugger.SetBreakpointRequest(), + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + client_version='client_version_value', + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.GetBreakpointRequest, + dict, +]) +def test_get_breakpoint(request_type, transport: str = 'grpc'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = debugger.GetBreakpointResponse( + ) + response = client.get_breakpoint(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.GetBreakpointRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.GetBreakpointResponse) + + +def test_get_breakpoint_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + client.get_breakpoint() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.GetBreakpointRequest() + + +@pytest.mark.asyncio +async def test_get_breakpoint_async(transport: str = 'grpc_asyncio', request_type=debugger.GetBreakpointRequest): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse( + )) + response = await client.get_breakpoint(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.GetBreakpointRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.GetBreakpointResponse) + + +@pytest.mark.asyncio +async def test_get_breakpoint_async_from_dict(): + await test_get_breakpoint_async(request_type=dict) + + +def test_get_breakpoint_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = debugger.GetBreakpointResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_breakpoint( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee_id + mock_val = 'debuggee_id_value' + assert arg == mock_val + arg = args[0].breakpoint_id + mock_val = 'breakpoint_id_value' + assert arg == mock_val + arg = args[0].client_version + mock_val = 'client_version_value' + assert arg == mock_val + + +def test_get_breakpoint_flattened_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.get_breakpoint( + debugger.GetBreakpointRequest(), + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + + +@pytest.mark.asyncio +async def test_get_breakpoint_flattened_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = debugger.GetBreakpointResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_breakpoint( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee_id + mock_val = 'debuggee_id_value' + assert arg == mock_val + arg = args[0].breakpoint_id + mock_val = 'breakpoint_id_value' + assert arg == mock_val + arg = args[0].client_version + mock_val = 'client_version_value' + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_get_breakpoint_flattened_error_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.get_breakpoint( + debugger.GetBreakpointRequest(), + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.DeleteBreakpointRequest, + dict, +]) +def test_delete_breakpoint(request_type, transport: str = 'grpc'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_breakpoint(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.DeleteBreakpointRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_breakpoint_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + client.delete_breakpoint() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.DeleteBreakpointRequest() + + +@pytest.mark.asyncio +async def test_delete_breakpoint_async(transport: str = 'grpc_asyncio', request_type=debugger.DeleteBreakpointRequest): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_breakpoint(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.DeleteBreakpointRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_breakpoint_async_from_dict(): + await test_delete_breakpoint_async(request_type=dict) + + +def test_delete_breakpoint_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.delete_breakpoint( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee_id + mock_val = 'debuggee_id_value' + assert arg == mock_val + arg = args[0].breakpoint_id + mock_val = 'breakpoint_id_value' + assert arg == mock_val + arg = args[0].client_version + mock_val = 'client_version_value' + assert arg == mock_val + + +def test_delete_breakpoint_flattened_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.delete_breakpoint( + debugger.DeleteBreakpointRequest(), + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + + +@pytest.mark.asyncio +async def test_delete_breakpoint_flattened_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.delete_breakpoint( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee_id + mock_val = 'debuggee_id_value' + assert arg == mock_val + arg = args[0].breakpoint_id + mock_val = 'breakpoint_id_value' + assert arg == mock_val + arg = args[0].client_version + mock_val = 'client_version_value' + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_delete_breakpoint_flattened_error_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.delete_breakpoint( + debugger.DeleteBreakpointRequest(), + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.ListBreakpointsRequest, + dict, +]) +def test_list_breakpoints(request_type, transport: str = 'grpc'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = debugger.ListBreakpointsResponse( + next_wait_token='next_wait_token_value', + ) + response = client.list_breakpoints(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.ListBreakpointsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.ListBreakpointsResponse) + assert response.next_wait_token == 'next_wait_token_value' + + +def test_list_breakpoints_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + client.list_breakpoints() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.ListBreakpointsRequest() + + +@pytest.mark.asyncio +async def test_list_breakpoints_async(transport: str = 'grpc_asyncio', request_type=debugger.ListBreakpointsRequest): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse( + next_wait_token='next_wait_token_value', + )) + response = await client.list_breakpoints(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.ListBreakpointsRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.ListBreakpointsResponse) + assert response.next_wait_token == 'next_wait_token_value' + + +@pytest.mark.asyncio +async def test_list_breakpoints_async_from_dict(): + await test_list_breakpoints_async(request_type=dict) + + +def test_list_breakpoints_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = debugger.ListBreakpointsResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_breakpoints( + debuggee_id='debuggee_id_value', + client_version='client_version_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee_id + mock_val = 'debuggee_id_value' + assert arg == mock_val + arg = args[0].client_version + mock_val = 'client_version_value' + assert arg == mock_val + + +def test_list_breakpoints_flattened_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_breakpoints( + debugger.ListBreakpointsRequest(), + debuggee_id='debuggee_id_value', + client_version='client_version_value', + ) + + +@pytest.mark.asyncio +async def test_list_breakpoints_flattened_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = debugger.ListBreakpointsResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_breakpoints( + debuggee_id='debuggee_id_value', + client_version='client_version_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].debuggee_id + mock_val = 'debuggee_id_value' + assert arg == mock_val + arg = args[0].client_version + mock_val = 'client_version_value' + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_list_breakpoints_flattened_error_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_breakpoints( + debugger.ListBreakpointsRequest(), + debuggee_id='debuggee_id_value', + client_version='client_version_value', + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.ListDebuggeesRequest, + dict, +]) +def test_list_debuggees(request_type, transport: str = 'grpc'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_debuggees), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = debugger.ListDebuggeesResponse( + ) + response = client.list_debuggees(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.ListDebuggeesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.ListDebuggeesResponse) + + +def test_list_debuggees_empty_call(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_debuggees), + '__call__') as call: + client.list_debuggees() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.ListDebuggeesRequest() + + +@pytest.mark.asyncio +async def test_list_debuggees_async(transport: str = 'grpc_asyncio', request_type=debugger.ListDebuggeesRequest): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Everything is optional in proto3 as far as the runtime is concerned, + # and we are mocking out the actual API, so just send an empty request. + request = request_type() + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_debuggees), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListDebuggeesResponse( + )) + response = await client.list_debuggees(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + assert args[0] == debugger.ListDebuggeesRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.ListDebuggeesResponse) + + +@pytest.mark.asyncio +async def test_list_debuggees_async_from_dict(): + await test_list_debuggees_async(request_type=dict) + + +def test_list_debuggees_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_debuggees), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = debugger.ListDebuggeesResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.list_debuggees( + project='project_value', + client_version='client_version_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + arg = args[0].project + mock_val = 'project_value' + assert arg == mock_val + arg = args[0].client_version + mock_val = 'client_version_value' + assert arg == mock_val + + +def test_list_debuggees_flattened_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + client.list_debuggees( + debugger.ListDebuggeesRequest(), + project='project_value', + client_version='client_version_value', + ) + + +@pytest.mark.asyncio +async def test_list_debuggees_flattened_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_debuggees), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = debugger.ListDebuggeesResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListDebuggeesResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.list_debuggees( + project='project_value', + client_version='client_version_value', + ) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + arg = args[0].project + mock_val = 'project_value' + assert arg == mock_val + arg = args[0].client_version + mock_val = 'client_version_value' + assert arg == mock_val + + +@pytest.mark.asyncio +async def test_list_debuggees_flattened_error_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Attempting to call a method with both a request object and flattened + # fields is an error. + with pytest.raises(ValueError): + await client.list_debuggees( + debugger.ListDebuggeesRequest(), + project='project_value', + client_version='client_version_value', + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.Debugger2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.Debugger2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = Debugger2Client( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.Debugger2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = Debugger2Client( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = mock.Mock() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = Debugger2Client( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.Debugger2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = Debugger2Client( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.Debugger2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = Debugger2Client(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.Debugger2GrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.Debugger2GrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.Debugger2GrpcTransport, + transports.Debugger2GrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.Debugger2GrpcTransport, + ) + +def test_debugger2_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.Debugger2Transport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_debugger2_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.debugger_v2.services.debugger2.transports.Debugger2Transport.__init__') as Transport: + Transport.return_value = None + transport = transports.Debugger2Transport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'set_breakpoint', + 'get_breakpoint', + 'delete_breakpoint', + 'list_breakpoints', + 'list_debuggees', + ) + for method in methods: + with pytest.raises(NotImplementedError): + getattr(transport, method)(request=object()) + + with pytest.raises(NotImplementedError): + transport.close() + + +def test_debugger2_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.debugger_v2.services.debugger2.transports.Debugger2Transport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.Debugger2Transport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/cloud_debugger', +), + quota_project_id="octopus", + ) + + +def test_debugger2_base_transport_with_adc(): + # Test the default credentials are used if credentials and credentials_file are None. + with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.debugger_v2.services.debugger2.transports.Debugger2Transport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.Debugger2Transport() + adc.assert_called_once() + + +def test_debugger2_auth_adc(): + # If no credentials are provided, we should use ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + Debugger2Client() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/cloud_debugger', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.Debugger2GrpcTransport, + transports.Debugger2GrpcAsyncIOTransport, + ], +) +def test_debugger2_transport_auth_adc(transport_class): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport_class(quota_project_id="octopus", scopes=["1", "2"]) + adc.assert_called_once_with( + scopes=["1", "2"], + default_scopes=( 'https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud_debugger',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class,grpc_helpers", + [ + (transports.Debugger2GrpcTransport, grpc_helpers), + (transports.Debugger2GrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_debugger2_transport_create_channel(transport_class, grpc_helpers): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( + grpc_helpers, "create_channel", autospec=True + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + adc.return_value = (creds, None) + transport_class( + quota_project_id="octopus", + scopes=["1", "2"] + ) + + create_channel.assert_called_with( + "clouddebugger.googleapis.com:443", + credentials=creds, + credentials_file=None, + quota_project_id="octopus", + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/cloud_debugger', +), + scopes=["1", "2"], + default_host="clouddebugger.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.Debugger2GrpcTransport, transports.Debugger2GrpcAsyncIOTransport]) +def test_debugger2_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = ga_credentials.AnonymousCredentials() + + # Check ssl_channel_credentials is used if provided. + with mock.patch.object(transport_class, "create_channel") as mock_create_channel: + mock_ssl_channel_creds = mock.Mock() + transport_class( + host="squid.clam.whelk", + credentials=cred, + ssl_channel_credentials=mock_ssl_channel_creds + ) + mock_create_channel.assert_called_once_with( + "squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_channel_creds, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls + # is used. + with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): + with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: + transport_class( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + expected_cert, expected_key = client_cert_source_callback() + mock_ssl_cred.assert_called_once_with( + certificate_chain=expected_cert, + private_key=expected_key + ) + + +def test_debugger2_host_no_port(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), + ) + assert client.transport._host == 'clouddebugger.googleapis.com:443' + + +def test_debugger2_host_with_port(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), + ) + assert client.transport._host == 'clouddebugger.googleapis.com:8000' + +def test_debugger2_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.Debugger2GrpcTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +def test_debugger2_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.Debugger2GrpcAsyncIOTransport( + host="squid.clam.whelk", + channel=channel, + ) + assert transport.grpc_channel == channel + assert transport._host == "squid.clam.whelk:443" + assert transport._ssl_channel_credentials == None + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.Debugger2GrpcTransport, transports.Debugger2GrpcAsyncIOTransport]) +def test_debugger2_transport_channel_mtls_with_client_cert_source( + transport_class +): + with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_ssl_cred = mock.Mock() + grpc_ssl_channel_cred.return_value = mock_ssl_cred + + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + + cred = ga_credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(google.auth, 'default') as adc: + adc.return_value = (cred, None) + transport = transport_class( + host="squid.clam.whelk", + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=client_cert_source_callback, + ) + adc.assert_called_once() + + grpc_ssl_channel_cred.assert_called_once_with( + certificate_chain=b"cert bytes", private_key=b"key bytes" + ) + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + assert transport._ssl_channel_credentials == mock_ssl_cred + + +# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are +# removed from grpc/grpc_asyncio transport constructor. +@pytest.mark.parametrize("transport_class", [transports.Debugger2GrpcTransport, transports.Debugger2GrpcAsyncIOTransport]) +def test_debugger2_transport_channel_mtls_with_adc( + transport_class +): + mock_ssl_cred = mock.Mock() + with mock.patch.multiple( + "google.auth.transport.grpc.SslCredentials", + __init__=mock.Mock(return_value=None), + ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), + ): + with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: + mock_grpc_channel = mock.Mock() + grpc_create_channel.return_value = mock_grpc_channel + mock_cred = mock.Mock() + + with pytest.warns(DeprecationWarning): + transport = transport_class( + host="squid.clam.whelk", + credentials=mock_cred, + api_mtls_endpoint="mtls.squid.clam.whelk", + client_cert_source=None, + ) + + grpc_create_channel.assert_called_once_with( + "mtls.squid.clam.whelk:443", + credentials=mock_cred, + credentials_file=None, + scopes=None, + ssl_credentials=mock_ssl_cred, + quota_project_id=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + assert transport.grpc_channel == mock_grpc_channel + + +def test_common_billing_account_path(): + billing_account = "squid" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = Debugger2Client.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "clam", + } + path = Debugger2Client.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = Debugger2Client.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "whelk" + expected = "folders/{folder}".format(folder=folder, ) + actual = Debugger2Client.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "octopus", + } + path = Debugger2Client.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = Debugger2Client.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "oyster" + expected = "organizations/{organization}".format(organization=organization, ) + actual = Debugger2Client.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "nudibranch", + } + path = Debugger2Client.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = Debugger2Client.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "cuttlefish" + expected = "projects/{project}".format(project=project, ) + actual = Debugger2Client.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "mussel", + } + path = Debugger2Client.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = Debugger2Client.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "winkle" + location = "nautilus" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = Debugger2Client.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "scallop", + "location": "abalone", + } + path = Debugger2Client.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = Debugger2Client.parse_common_location_path(path) + assert expected == actual + + +def test_client_with_default_client_info(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.Debugger2Transport, '_prep_wrapped_messages') as prep: + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.Debugger2Transport, '_prep_wrapped_messages') as prep: + transport_class = Debugger2Client.get_transport_class() + transport = transport_class( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + +@pytest.mark.asyncio +async def test_transport_close_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc_asyncio", + ) + with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: + async with client: + close.assert_not_called() + close.assert_called_once() + +def test_transport_close(): + transports = { + "grpc": "_grpc_channel", + } + + for transport, close_name in transports.items(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: + with client: + close.assert_not_called() + close.assert_called_once() + +def test_client_ctx(): + transports = [ + 'grpc', + ] + for transport in transports: + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport + ) + # Test client calls underlying transport. + with mock.patch.object(type(client.transport), "close") as close: + close.assert_not_called() + with client: + pass + close.assert_called() + +@pytest.mark.parametrize("client_class,transport_class", [ + (Debugger2Client, transports.Debugger2GrpcTransport), + (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport), +]) +def test_api_key_credentials(client_class, transport_class): + with mock.patch.object( + google.auth._default, "get_api_key_credentials", create=True + ) as get_api_key_credentials: + mock_cred = mock.Mock() + get_api_key_credentials.return_value = mock_cred + options = client_options.ClientOptions() + options.api_key = "api_key" + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options) + patched.assert_called_once_with( + credentials=mock_cred, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) From f9df937f338798da9eb1544c97e98b5a5642efc1 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Thu, 3 Feb 2022 00:41:08 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot?= 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 --- .../services/controller2/async_client.py | 6 +- .../services/controller2/client.py | 6 +- .../services/controller2/transports/grpc.py | 5 +- .../controller2/transports/grpc_asyncio.py | 5 +- .../services/debugger2/async_client.py | 10 +- .../debugger_v2/services/debugger2/client.py | 10 +- .../services/debugger2/transports/grpc.py | 5 +- .../debugger2/transports/grpc_asyncio.py | 5 +- owl-bot-staging/v2/.coveragerc | 17 - owl-bot-staging/v2/MANIFEST.in | 2 - owl-bot-staging/v2/README.rst | 49 - owl-bot-staging/v2/docs/conf.py | 376 ---- .../v2/docs/debugger_v2/controller2.rst | 6 - .../v2/docs/debugger_v2/debugger2.rst | 6 - .../v2/docs/debugger_v2/services.rst | 7 - owl-bot-staging/v2/docs/debugger_v2/types.rst | 7 - owl-bot-staging/v2/docs/index.rst | 7 - .../v2/google/cloud/debugger/__init__.py | 71 - .../v2/google/cloud/debugger/py.typed | 2 - .../v2/google/cloud/debugger_v2/__init__.py | 72 - .../cloud/debugger_v2/gapic_metadata.json | 117 - .../v2/google/cloud/debugger_v2/py.typed | 2 - .../cloud/debugger_v2/services/__init__.py | 15 - .../services/controller2/__init__.py | 22 - .../services/controller2/async_client.py | 478 ---- .../services/controller2/client.py | 651 ------ .../controller2/transports/__init__.py | 33 - .../services/controller2/transports/base.py | 188 -- .../services/controller2/transports/grpc.py | 362 --- .../controller2/transports/grpc_asyncio.py | 366 --- .../services/debugger2/__init__.py | 22 - .../services/debugger2/async_client.py | 644 ------ .../debugger_v2/services/debugger2/client.py | 803 ------- .../services/debugger2/transports/__init__.py | 33 - .../services/debugger2/transports/base.py | 231 -- .../services/debugger2/transports/grpc.py | 374 ---- .../debugger2/transports/grpc_asyncio.py | 378 ---- .../cloud/debugger_v2/types/__init__.py | 68 - .../cloud/debugger_v2/types/controller.py | 172 -- .../v2/google/cloud/debugger_v2/types/data.py | 636 ------ .../cloud/debugger_v2/types/debugger.py | 311 --- owl-bot-staging/v2/mypy.ini | 3 - owl-bot-staging/v2/noxfile.py | 132 -- .../v2/scripts/fixup_debugger_v2_keywords.py | 183 -- owl-bot-staging/v2/setup.py | 54 - owl-bot-staging/v2/tests/__init__.py | 16 - owl-bot-staging/v2/tests/unit/__init__.py | 16 - .../v2/tests/unit/gapic/__init__.py | 16 - .../tests/unit/gapic/debugger_v2/__init__.py | 16 - .../gapic/debugger_v2/test_controller2.py | 1580 ------------- .../unit/gapic/debugger_v2/test_debugger2.py | 1981 ----------------- .../gapic/debugger_v2/test_controller2.py | 72 +- .../unit/gapic/debugger_v2/test_debugger2.py | 72 +- 53 files changed, 170 insertions(+), 10551 deletions(-) delete mode 100644 owl-bot-staging/v2/.coveragerc delete mode 100644 owl-bot-staging/v2/MANIFEST.in delete mode 100644 owl-bot-staging/v2/README.rst delete mode 100644 owl-bot-staging/v2/docs/conf.py delete mode 100644 owl-bot-staging/v2/docs/debugger_v2/controller2.rst delete mode 100644 owl-bot-staging/v2/docs/debugger_v2/debugger2.rst delete mode 100644 owl-bot-staging/v2/docs/debugger_v2/services.rst delete mode 100644 owl-bot-staging/v2/docs/debugger_v2/types.rst delete mode 100644 owl-bot-staging/v2/docs/index.rst delete mode 100644 owl-bot-staging/v2/google/cloud/debugger/__init__.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger/py.typed delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/py.typed delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py delete mode 100644 owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py delete mode 100644 owl-bot-staging/v2/mypy.ini delete mode 100644 owl-bot-staging/v2/noxfile.py delete mode 100644 owl-bot-staging/v2/scripts/fixup_debugger_v2_keywords.py delete mode 100644 owl-bot-staging/v2/setup.py delete mode 100644 owl-bot-staging/v2/tests/__init__.py delete mode 100644 owl-bot-staging/v2/tests/unit/__init__.py delete mode 100644 owl-bot-staging/v2/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py delete mode 100644 owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py delete mode 100644 owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py diff --git a/google/cloud/debugger_v2/services/controller2/async_client.py b/google/cloud/debugger_v2/services/controller2/async_client.py index 43d7124..7001c67 100644 --- a/google/cloud/debugger_v2/services/controller2/async_client.py +++ b/google/cloud/debugger_v2/services/controller2/async_client.py @@ -262,7 +262,7 @@ async def register_debuggee( Response for registering a debuggee. """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee]) if request is not None and has_flattened_params: @@ -337,7 +337,7 @@ async def list_active_breakpoints( """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee_id]) if request is not None and has_flattened_params: @@ -430,7 +430,7 @@ async def update_active_breakpoint( """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee_id, breakpoint_]) if request is not None and has_flattened_params: diff --git a/google/cloud/debugger_v2/services/controller2/client.py b/google/cloud/debugger_v2/services/controller2/client.py index feed0a5..e7ae8a0 100644 --- a/google/cloud/debugger_v2/services/controller2/client.py +++ b/google/cloud/debugger_v2/services/controller2/client.py @@ -447,7 +447,7 @@ def register_debuggee( Response for registering a debuggee. """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee]) if request is not None and has_flattened_params: @@ -522,7 +522,7 @@ def list_active_breakpoints( """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee_id]) if request is not None and has_flattened_params: @@ -605,7 +605,7 @@ def update_active_breakpoint( """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee_id, breakpoint_]) if request is not None and has_flattened_params: diff --git a/google/cloud/debugger_v2/services/controller2/transports/grpc.py b/google/cloud/debugger_v2/services/controller2/transports/grpc.py index df92004..4d914f0 100644 --- a/google/cloud/debugger_v2/services/controller2/transports/grpc.py +++ b/google/cloud/debugger_v2/services/controller2/transports/grpc.py @@ -179,8 +179,11 @@ def __init__( if not self._grpc_channel: self._grpc_channel = type(self).create_channel( self._host, + # use the credentials which are saved credentials=self._credentials, - credentials_file=credentials_file, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, scopes=self._scopes, ssl_credentials=self._ssl_channel_credentials, quota_project_id=quota_project_id, diff --git a/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py b/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py index 6236e18..5bf44a7 100644 --- a/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py +++ b/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py @@ -224,8 +224,11 @@ def __init__( if not self._grpc_channel: self._grpc_channel = type(self).create_channel( self._host, + # use the credentials which are saved credentials=self._credentials, - credentials_file=credentials_file, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, scopes=self._scopes, ssl_credentials=self._ssl_channel_credentials, quota_project_id=quota_project_id, diff --git a/google/cloud/debugger_v2/services/debugger2/async_client.py b/google/cloud/debugger_v2/services/debugger2/async_client.py index d1830eb..3be4f23 100644 --- a/google/cloud/debugger_v2/services/debugger2/async_client.py +++ b/google/cloud/debugger_v2/services/debugger2/async_client.py @@ -256,7 +256,7 @@ async def set_breakpoint( Response for setting a breakpoint. """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee_id, breakpoint_, client_version]) if request is not None and has_flattened_params: @@ -342,7 +342,7 @@ async def get_breakpoint( """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee_id, breakpoint_id, client_version]) if request is not None and has_flattened_params: @@ -431,7 +431,7 @@ async def delete_breakpoint( sent along with the request as metadata. """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee_id, breakpoint_id, client_version]) if request is not None and has_flattened_params: @@ -515,7 +515,7 @@ async def list_breakpoints( Response for listing breakpoints. """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee_id, client_version]) if request is not None and has_flattened_params: @@ -598,7 +598,7 @@ async def list_debuggees( Response for listing debuggees. """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([project, client_version]) if request is not None and has_flattened_params: diff --git a/google/cloud/debugger_v2/services/debugger2/client.py b/google/cloud/debugger_v2/services/debugger2/client.py index 33ede0c..e673360 100644 --- a/google/cloud/debugger_v2/services/debugger2/client.py +++ b/google/cloud/debugger_v2/services/debugger2/client.py @@ -443,7 +443,7 @@ def set_breakpoint( Response for setting a breakpoint. """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee_id, breakpoint_, client_version]) if request is not None and has_flattened_params: @@ -529,7 +529,7 @@ def get_breakpoint( """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee_id, breakpoint_id, client_version]) if request is not None and has_flattened_params: @@ -608,7 +608,7 @@ def delete_breakpoint( sent along with the request as metadata. """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee_id, breakpoint_id, client_version]) if request is not None and has_flattened_params: @@ -682,7 +682,7 @@ def list_breakpoints( Response for listing breakpoints. """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([debuggee_id, client_version]) if request is not None and has_flattened_params: @@ -755,7 +755,7 @@ def list_debuggees( Response for listing debuggees. """ # Create or coerce a protobuf request object. - # Sanity check: If we got a request object, we should *not* have + # Quick check: If we got a request object, we should *not* have # gotten any keyword arguments that map to the request. has_flattened_params = any([project, client_version]) if request is not None and has_flattened_params: diff --git a/google/cloud/debugger_v2/services/debugger2/transports/grpc.py b/google/cloud/debugger_v2/services/debugger2/transports/grpc.py index c8dc7db..63eb70c 100644 --- a/google/cloud/debugger_v2/services/debugger2/transports/grpc.py +++ b/google/cloud/debugger_v2/services/debugger2/transports/grpc.py @@ -171,8 +171,11 @@ def __init__( if not self._grpc_channel: self._grpc_channel = type(self).create_channel( self._host, + # use the credentials which are saved credentials=self._credentials, - credentials_file=credentials_file, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, scopes=self._scopes, ssl_credentials=self._ssl_channel_credentials, quota_project_id=quota_project_id, diff --git a/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py b/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py index 4d0450d..dff4de1 100644 --- a/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py +++ b/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py @@ -216,8 +216,11 @@ def __init__( if not self._grpc_channel: self._grpc_channel = type(self).create_channel( self._host, + # use the credentials which are saved credentials=self._credentials, - credentials_file=credentials_file, + # Set ``credentials_file`` to ``None`` here as + # the credentials that we saved earlier should be used. + credentials_file=None, scopes=self._scopes, ssl_credentials=self._ssl_channel_credentials, quota_project_id=quota_project_id, diff --git a/owl-bot-staging/v2/.coveragerc b/owl-bot-staging/v2/.coveragerc deleted file mode 100644 index d63da53..0000000 --- a/owl-bot-staging/v2/.coveragerc +++ /dev/null @@ -1,17 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/debugger/__init__.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ - # Ignore pkg_resources exceptions. - # This is added at the module level as a safeguard for if someone - # generates the code and tries to run it without pip installing. This - # makes it virtually impossible to test properly. - except pkg_resources.DistributionNotFound diff --git a/owl-bot-staging/v2/MANIFEST.in b/owl-bot-staging/v2/MANIFEST.in deleted file mode 100644 index f82c9a7..0000000 --- a/owl-bot-staging/v2/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/debugger *.py -recursive-include google/cloud/debugger_v2 *.py diff --git a/owl-bot-staging/v2/README.rst b/owl-bot-staging/v2/README.rst deleted file mode 100644 index e042ba5..0000000 --- a/owl-bot-staging/v2/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Debugger API -================================================= - -Quick Start ------------ - -In order to use this library, you first need to go through the following steps: - -1. `Select or create a Cloud Platform project.`_ -2. `Enable billing for your project.`_ -3. Enable the Google Cloud Debugger API. -4. `Setup Authentication.`_ - -.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project -.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project -.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html - -Installation -~~~~~~~~~~~~ - -Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to -create isolated Python environments. The basic problem it addresses is one of -dependencies and versions, and indirectly permissions. - -With `virtualenv`_, it's possible to install this library without needing system -install permissions, and without clashing with the installed system -dependencies. - -.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/ - - -Mac/Linux -^^^^^^^^^ - -.. code-block:: console - - python3 -m venv - source /bin/activate - /bin/pip install /path/to/library - - -Windows -^^^^^^^ - -.. code-block:: console - - python3 -m venv - \Scripts\activate - \Scripts\pip.exe install \path\to\library diff --git a/owl-bot-staging/v2/docs/conf.py b/owl-bot-staging/v2/docs/conf.py deleted file mode 100644 index bfac8d2..0000000 --- a/owl-bot-staging/v2/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -# -# google-cloud-debugger-client documentation build configuration file -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os -import shlex - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath("..")) - -__version__ = "0.1.0" - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "4.0.1" - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - "sphinx.ext.autodoc", - "sphinx.ext.autosummary", - "sphinx.ext.intersphinx", - "sphinx.ext.coverage", - "sphinx.ext.napoleon", - "sphinx.ext.todo", - "sphinx.ext.viewcode", -] - -# autodoc/autosummary flags -autoclass_content = "both" -autodoc_default_flags = ["members"] -autosummary_generate = True - - -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] - -# Allow markdown includes (so releases.md can include CHANGLEOG.md) -# http://www.sphinx-doc.org/en/master/markdown.html -source_parsers = {".md": "recommonmark.parser.CommonMarkParser"} - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -source_suffix = [".rst", ".md"] - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The root toctree document. -root_doc = "index" - -# General information about the project. -project = u"google-cloud-debugger-client" -copyright = u"2020, Google, LLC" -author = u"Google APIs" # TODO: autogenerate this bit - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The full version, including alpha/beta/rc tags. -release = __version__ -# The short X.Y version. -version = ".".join(release.split(".")[0:2]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "description": "Google Cloud Client Libraries for Python", - "github_user": "googleapis", - "github_repo": "google-cloud-python", - "github_banner": True, - "font_family": "'Roboto', Georgia, sans", - "head_font_family": "'Roboto', Georgia, serif", - "code_font_family": "'Roboto Mono', 'Consolas', monospace", -} - -# Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -# html_use_index = True - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -# html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -# html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -# html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = "google-cloud-debugger-client-doc" - -# -- Options for warnings ------------------------------------------------------ - - -suppress_warnings = [ - # Temporarily suppress this to avoid "more than one target found for - # cross-reference" warning, which are intractable for us to avoid while in - # a mono-repo. - # See https://github.com/sphinx-doc/sphinx/blob - # /2a65ffeef5c107c19084fabdd706cdff3f52d93c/sphinx/domains/python.py#L843 - "ref.python" -] - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # 'preamble': '', - # Latex figure (float) alignment - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ( - root_doc, - "google-cloud-debugger-client.tex", - u"google-cloud-debugger-client Documentation", - author, - "manual", - ) -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ( - root_doc, - "google-cloud-debugger-client", - u"Google Cloud Debugger Documentation", - [author], - 1, - ) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - root_doc, - "google-cloud-debugger-client", - u"google-cloud-debugger-client Documentation", - author, - "google-cloud-debugger-client", - "GAPIC library for Google Cloud Debugger API", - "APIs", - ) -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = { - "python": ("http://python.readthedocs.org/en/latest/", None), - "gax": ("https://gax-python.readthedocs.org/en/latest/", None), - "google-auth": ("https://google-auth.readthedocs.io/en/stable", None), - "google-gax": ("https://gax-python.readthedocs.io/en/latest/", None), - "google.api_core": ("https://googleapis.dev/python/google-api-core/latest/", None), - "grpc": ("https://grpc.io/grpc/python/", None), - "requests": ("http://requests.kennethreitz.org/en/stable/", None), - "proto": ("https://proto-plus-python.readthedocs.io/en/stable", None), - "protobuf": ("https://googleapis.dev/python/protobuf/latest/", None), -} - - -# Napoleon settings -napoleon_google_docstring = True -napoleon_numpy_docstring = True -napoleon_include_private_with_doc = False -napoleon_include_special_with_doc = True -napoleon_use_admonition_for_examples = False -napoleon_use_admonition_for_notes = False -napoleon_use_admonition_for_references = False -napoleon_use_ivar = False -napoleon_use_param = True -napoleon_use_rtype = True diff --git a/owl-bot-staging/v2/docs/debugger_v2/controller2.rst b/owl-bot-staging/v2/docs/debugger_v2/controller2.rst deleted file mode 100644 index 1fbfbd1..0000000 --- a/owl-bot-staging/v2/docs/debugger_v2/controller2.rst +++ /dev/null @@ -1,6 +0,0 @@ -Controller2 ------------------------------ - -.. automodule:: google.cloud.debugger_v2.services.controller2 - :members: - :inherited-members: diff --git a/owl-bot-staging/v2/docs/debugger_v2/debugger2.rst b/owl-bot-staging/v2/docs/debugger_v2/debugger2.rst deleted file mode 100644 index f99c7c3..0000000 --- a/owl-bot-staging/v2/docs/debugger_v2/debugger2.rst +++ /dev/null @@ -1,6 +0,0 @@ -Debugger2 ---------------------------- - -.. automodule:: google.cloud.debugger_v2.services.debugger2 - :members: - :inherited-members: diff --git a/owl-bot-staging/v2/docs/debugger_v2/services.rst b/owl-bot-staging/v2/docs/debugger_v2/services.rst deleted file mode 100644 index b462437..0000000 --- a/owl-bot-staging/v2/docs/debugger_v2/services.rst +++ /dev/null @@ -1,7 +0,0 @@ -Services for Google Cloud Debugger v2 API -========================================= -.. toctree:: - :maxdepth: 2 - - controller2 - debugger2 diff --git a/owl-bot-staging/v2/docs/debugger_v2/types.rst b/owl-bot-staging/v2/docs/debugger_v2/types.rst deleted file mode 100644 index b649b71..0000000 --- a/owl-bot-staging/v2/docs/debugger_v2/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -Types for Google Cloud Debugger v2 API -====================================== - -.. automodule:: google.cloud.debugger_v2.types - :members: - :undoc-members: - :show-inheritance: diff --git a/owl-bot-staging/v2/docs/index.rst b/owl-bot-staging/v2/docs/index.rst deleted file mode 100644 index 004b591..0000000 --- a/owl-bot-staging/v2/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - debugger_v2/services - debugger_v2/types diff --git a/owl-bot-staging/v2/google/cloud/debugger/__init__.py b/owl-bot-staging/v2/google/cloud/debugger/__init__.py deleted file mode 100644 index f9522f1..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger/__init__.py +++ /dev/null @@ -1,71 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# - -from google.cloud.debugger_v2.services.controller2.client import Controller2Client -from google.cloud.debugger_v2.services.controller2.async_client import Controller2AsyncClient -from google.cloud.debugger_v2.services.debugger2.client import Debugger2Client -from google.cloud.debugger_v2.services.debugger2.async_client import Debugger2AsyncClient - -from google.cloud.debugger_v2.types.controller import ListActiveBreakpointsRequest -from google.cloud.debugger_v2.types.controller import ListActiveBreakpointsResponse -from google.cloud.debugger_v2.types.controller import RegisterDebuggeeRequest -from google.cloud.debugger_v2.types.controller import RegisterDebuggeeResponse -from google.cloud.debugger_v2.types.controller import UpdateActiveBreakpointRequest -from google.cloud.debugger_v2.types.controller import UpdateActiveBreakpointResponse -from google.cloud.debugger_v2.types.data import Breakpoint -from google.cloud.debugger_v2.types.data import Debuggee -from google.cloud.debugger_v2.types.data import FormatMessage -from google.cloud.debugger_v2.types.data import SourceLocation -from google.cloud.debugger_v2.types.data import StackFrame -from google.cloud.debugger_v2.types.data import StatusMessage -from google.cloud.debugger_v2.types.data import Variable -from google.cloud.debugger_v2.types.debugger import DeleteBreakpointRequest -from google.cloud.debugger_v2.types.debugger import GetBreakpointRequest -from google.cloud.debugger_v2.types.debugger import GetBreakpointResponse -from google.cloud.debugger_v2.types.debugger import ListBreakpointsRequest -from google.cloud.debugger_v2.types.debugger import ListBreakpointsResponse -from google.cloud.debugger_v2.types.debugger import ListDebuggeesRequest -from google.cloud.debugger_v2.types.debugger import ListDebuggeesResponse -from google.cloud.debugger_v2.types.debugger import SetBreakpointRequest -from google.cloud.debugger_v2.types.debugger import SetBreakpointResponse - -__all__ = ('Controller2Client', - 'Controller2AsyncClient', - 'Debugger2Client', - 'Debugger2AsyncClient', - 'ListActiveBreakpointsRequest', - 'ListActiveBreakpointsResponse', - 'RegisterDebuggeeRequest', - 'RegisterDebuggeeResponse', - 'UpdateActiveBreakpointRequest', - 'UpdateActiveBreakpointResponse', - 'Breakpoint', - 'Debuggee', - 'FormatMessage', - 'SourceLocation', - 'StackFrame', - 'StatusMessage', - 'Variable', - 'DeleteBreakpointRequest', - 'GetBreakpointRequest', - 'GetBreakpointResponse', - 'ListBreakpointsRequest', - 'ListBreakpointsResponse', - 'ListDebuggeesRequest', - 'ListDebuggeesResponse', - 'SetBreakpointRequest', - 'SetBreakpointResponse', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger/py.typed b/owl-bot-staging/v2/google/cloud/debugger/py.typed deleted file mode 100644 index a6f27ff..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-debugger-client package uses inline types. diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py deleted file mode 100644 index 6bea361..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py +++ /dev/null @@ -1,72 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# - -from .services.controller2 import Controller2Client -from .services.controller2 import Controller2AsyncClient -from .services.debugger2 import Debugger2Client -from .services.debugger2 import Debugger2AsyncClient - -from .types.controller import ListActiveBreakpointsRequest -from .types.controller import ListActiveBreakpointsResponse -from .types.controller import RegisterDebuggeeRequest -from .types.controller import RegisterDebuggeeResponse -from .types.controller import UpdateActiveBreakpointRequest -from .types.controller import UpdateActiveBreakpointResponse -from .types.data import Breakpoint -from .types.data import Debuggee -from .types.data import FormatMessage -from .types.data import SourceLocation -from .types.data import StackFrame -from .types.data import StatusMessage -from .types.data import Variable -from .types.debugger import DeleteBreakpointRequest -from .types.debugger import GetBreakpointRequest -from .types.debugger import GetBreakpointResponse -from .types.debugger import ListBreakpointsRequest -from .types.debugger import ListBreakpointsResponse -from .types.debugger import ListDebuggeesRequest -from .types.debugger import ListDebuggeesResponse -from .types.debugger import SetBreakpointRequest -from .types.debugger import SetBreakpointResponse - -__all__ = ( - 'Controller2AsyncClient', - 'Debugger2AsyncClient', -'Breakpoint', -'Controller2Client', -'Debuggee', -'Debugger2Client', -'DeleteBreakpointRequest', -'FormatMessage', -'GetBreakpointRequest', -'GetBreakpointResponse', -'ListActiveBreakpointsRequest', -'ListActiveBreakpointsResponse', -'ListBreakpointsRequest', -'ListBreakpointsResponse', -'ListDebuggeesRequest', -'ListDebuggeesResponse', -'RegisterDebuggeeRequest', -'RegisterDebuggeeResponse', -'SetBreakpointRequest', -'SetBreakpointResponse', -'SourceLocation', -'StackFrame', -'StatusMessage', -'UpdateActiveBreakpointRequest', -'UpdateActiveBreakpointResponse', -'Variable', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json deleted file mode 100644 index fce739c..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json +++ /dev/null @@ -1,117 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.debugger_v2", - "protoPackage": "google.devtools.clouddebugger.v2", - "schema": "1.0", - "services": { - "Controller2": { - "clients": { - "grpc": { - "libraryClient": "Controller2Client", - "rpcs": { - "ListActiveBreakpoints": { - "methods": [ - "list_active_breakpoints" - ] - }, - "RegisterDebuggee": { - "methods": [ - "register_debuggee" - ] - }, - "UpdateActiveBreakpoint": { - "methods": [ - "update_active_breakpoint" - ] - } - } - }, - "grpc-async": { - "libraryClient": "Controller2AsyncClient", - "rpcs": { - "ListActiveBreakpoints": { - "methods": [ - "list_active_breakpoints" - ] - }, - "RegisterDebuggee": { - "methods": [ - "register_debuggee" - ] - }, - "UpdateActiveBreakpoint": { - "methods": [ - "update_active_breakpoint" - ] - } - } - } - } - }, - "Debugger2": { - "clients": { - "grpc": { - "libraryClient": "Debugger2Client", - "rpcs": { - "DeleteBreakpoint": { - "methods": [ - "delete_breakpoint" - ] - }, - "GetBreakpoint": { - "methods": [ - "get_breakpoint" - ] - }, - "ListBreakpoints": { - "methods": [ - "list_breakpoints" - ] - }, - "ListDebuggees": { - "methods": [ - "list_debuggees" - ] - }, - "SetBreakpoint": { - "methods": [ - "set_breakpoint" - ] - } - } - }, - "grpc-async": { - "libraryClient": "Debugger2AsyncClient", - "rpcs": { - "DeleteBreakpoint": { - "methods": [ - "delete_breakpoint" - ] - }, - "GetBreakpoint": { - "methods": [ - "get_breakpoint" - ] - }, - "ListBreakpoints": { - "methods": [ - "list_breakpoints" - ] - }, - "ListDebuggees": { - "methods": [ - "list_debuggees" - ] - }, - "SetBreakpoint": { - "methods": [ - "set_breakpoint" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/py.typed b/owl-bot-staging/v2/google/cloud/debugger_v2/py.typed deleted file mode 100644 index a6f27ff..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-debugger-client package uses inline types. diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py deleted file mode 100644 index 4de6597..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py deleted file mode 100644 index c59a888..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -from .client import Controller2Client -from .async_client import Controller2AsyncClient - -__all__ = ( - 'Controller2Client', - 'Controller2AsyncClient', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py deleted file mode 100644 index 23e4b1c..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py +++ /dev/null @@ -1,478 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -from collections import OrderedDict -import functools -import re -from typing import Dict, Optional, Sequence, Tuple, Type, Union -import pkg_resources - -from google.api_core.client_options import ClientOptions -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.cloud.debugger_v2.types import controller -from google.cloud.debugger_v2.types import data -from .transports.base import Controller2Transport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import Controller2GrpcAsyncIOTransport -from .client import Controller2Client - - -class Controller2AsyncClient: - """The Controller service provides the API for orchestrating a - collection of debugger agents to perform debugging tasks. These - agents are each attached to a process of an application which may - include one or more replicas. - - The debugger agents register with the Controller to identify the - application being debugged, the Debuggee. All agents that register - with the same data, represent the same Debuggee, and are assigned - the same ``debuggee_id``. - - The debugger agents call the Controller to retrieve the list of - active Breakpoints. Agents with the same ``debuggee_id`` get the - same breakpoints list. An agent that can fulfill the breakpoint - request updates the Controller with the breakpoint result. The - controller selects the first result received and discards the rest - of the results. Agents that poll again for active breakpoints will - no longer have the completed breakpoint in the list and should - remove that breakpoint from their attached process. - - The Controller service does not provide a way to retrieve the - results of a completed breakpoint. This functionality is available - using the Debugger service. - """ - - _client: Controller2Client - - DEFAULT_ENDPOINT = Controller2Client.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = Controller2Client.DEFAULT_MTLS_ENDPOINT - - common_billing_account_path = staticmethod(Controller2Client.common_billing_account_path) - parse_common_billing_account_path = staticmethod(Controller2Client.parse_common_billing_account_path) - common_folder_path = staticmethod(Controller2Client.common_folder_path) - parse_common_folder_path = staticmethod(Controller2Client.parse_common_folder_path) - common_organization_path = staticmethod(Controller2Client.common_organization_path) - parse_common_organization_path = staticmethod(Controller2Client.parse_common_organization_path) - common_project_path = staticmethod(Controller2Client.common_project_path) - parse_common_project_path = staticmethod(Controller2Client.parse_common_project_path) - common_location_path = staticmethod(Controller2Client.common_location_path) - parse_common_location_path = staticmethod(Controller2Client.parse_common_location_path) - - @classmethod - def from_service_account_info(cls, info: dict, *args, **kwargs): - """Creates an instance of this client using the provided credentials - info. - - Args: - info (dict): The service account private key info. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - Controller2AsyncClient: The constructed client. - """ - return Controller2Client.from_service_account_info.__func__(Controller2AsyncClient, info, *args, **kwargs) # type: ignore - - @classmethod - def from_service_account_file(cls, filename: str, *args, **kwargs): - """Creates an instance of this client using the provided credentials - file. - - Args: - filename (str): The path to the service account private key json - file. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - Controller2AsyncClient: The constructed client. - """ - return Controller2Client.from_service_account_file.__func__(Controller2AsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): - """Return the API endpoint and client cert source for mutual TLS. - - The client cert source is determined in the following order: - (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the - client cert source is None. - (2) if `client_options.client_cert_source` is provided, use the provided one; if the - default client cert source exists, use the default one; otherwise the client cert - source is None. - - The API endpoint is determined in the following order: - (1) if `client_options.api_endpoint` if provided, use the provided one. - (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the - default mTLS endpoint; if the environment variabel is "never", use the default API - endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise - use the default API endpoint. - - More details can be found at https://google.aip.dev/auth/4114. - - Args: - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. Only the `api_endpoint` and `client_cert_source` properties may be used - in this method. - - Returns: - Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the - client cert source to use. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If any errors happen. - """ - return Controller2Client.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> Controller2Transport: - """Returns the transport used by the client instance. - - Returns: - Controller2Transport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(Controller2Client).get_transport_class, type(Controller2Client)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, Controller2Transport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the controller2 client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Union[str, ~.Controller2Transport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (ClientOptions): Custom options for the client. It - won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - """ - self._client = Controller2Client( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def register_debuggee(self, - request: Union[controller.RegisterDebuggeeRequest, dict] = None, - *, - debuggee: data.Debuggee = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> controller.RegisterDebuggeeResponse: - r"""Registers the debuggee with the controller service. - - All agents attached to the same application must call this - method with exactly the same request content to get back the - same stable ``debuggee_id``. Agents should call this method - again whenever ``google.rpc.Code.NOT_FOUND`` is returned from - any controller method. - - This protocol allows the controller service to disable - debuggees, recover from data loss, or change the ``debuggee_id`` - format. Agents must handle ``debuggee_id`` value changing upon - re-registration. - - Args: - request (Union[google.cloud.debugger_v2.types.RegisterDebuggeeRequest, dict]): - The request object. Request to register a debuggee. - debuggee (:class:`google.cloud.debugger_v2.types.Debuggee`): - Required. Debuggee information to register. The fields - ``project``, ``uniquifier``, ``description`` and - ``agent_version`` of the debuggee must be set. - - This corresponds to the ``debuggee`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.RegisterDebuggeeResponse: - Response for registering a debuggee. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = controller.RegisterDebuggeeRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee is not None: - request.debuggee = debuggee - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.register_debuggee, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_active_breakpoints(self, - request: Union[controller.ListActiveBreakpointsRequest, dict] = None, - *, - debuggee_id: str = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> controller.ListActiveBreakpointsResponse: - r"""Returns the list of all active breakpoints for the debuggee. - - The breakpoint specification (``location``, ``condition``, and - ``expressions`` fields) is semantically immutable, although the - field values may change. For example, an agent may update the - location line number to reflect the actual line where the - breakpoint was set, but this doesn't change the breakpoint - semantics. - - This means that an agent does not need to check if a breakpoint - has changed when it encounters the same breakpoint on a - successive call. Moreover, an agent should remember the - breakpoints that are completed until the controller removes them - from the active list to avoid setting those breakpoints again. - - Args: - request (Union[google.cloud.debugger_v2.types.ListActiveBreakpointsRequest, dict]): - The request object. Request to list active breakpoints. - debuggee_id (:class:`str`): - Required. Identifies the debuggee. - This corresponds to the ``debuggee_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.ListActiveBreakpointsResponse: - Response for listing active - breakpoints. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee_id]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = controller.ListActiveBreakpointsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee_id is not None: - request.debuggee_id = debuggee_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_active_breakpoints, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def update_active_breakpoint(self, - request: Union[controller.UpdateActiveBreakpointRequest, dict] = None, - *, - debuggee_id: str = None, - breakpoint_: data.Breakpoint = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> controller.UpdateActiveBreakpointResponse: - r"""Updates the breakpoint state or mutable fields. The entire - Breakpoint message must be sent back to the controller service. - - Updates to active breakpoint fields are only allowed if the new - value does not change the breakpoint specification. Updates to - the ``location``, ``condition`` and ``expressions`` fields - should not alter the breakpoint semantics. These may only make - changes such as canonicalizing a value or snapping the location - to the correct line of code. - - Args: - request (Union[google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest, dict]): - The request object. Request to update an active - breakpoint. - debuggee_id (:class:`str`): - Required. Identifies the debuggee - being debugged. - - This corresponds to the ``debuggee_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - breakpoint_ (:class:`google.cloud.debugger_v2.types.Breakpoint`): - Required. Updated breakpoint information. The field - ``id`` must be set. The agent must echo all Breakpoint - specification fields in the update. - - This corresponds to the ``breakpoint_`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse: - Response for updating an active - breakpoint. The message is defined to - allow future extensions. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee_id, breakpoint_]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = controller.UpdateActiveBreakpointRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee_id is not None: - request.debuggee_id = debuggee_id - if breakpoint_ is not None: - request.breakpoint_ = breakpoint_ - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.update_active_breakpoint, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self): - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-debugger-client", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "Controller2AsyncClient", -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py deleted file mode 100644 index 9fe1ecd..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py +++ /dev/null @@ -1,651 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -from collections import OrderedDict -import os -import re -from typing import Dict, Optional, Sequence, Tuple, Type, Union -import pkg_resources - -from google.api_core import client_options as client_options_lib -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.cloud.debugger_v2.types import controller -from google.cloud.debugger_v2.types import data -from .transports.base import Controller2Transport, DEFAULT_CLIENT_INFO -from .transports.grpc import Controller2GrpcTransport -from .transports.grpc_asyncio import Controller2GrpcAsyncIOTransport - - -class Controller2ClientMeta(type): - """Metaclass for the Controller2 client. - - This provides class-level methods for building and retrieving - support objects (e.g. transport) without polluting the client instance - objects. - """ - _transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] - _transport_registry["grpc"] = Controller2GrpcTransport - _transport_registry["grpc_asyncio"] = Controller2GrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[Controller2Transport]: - """Returns an appropriate transport class. - - Args: - label: The name of the desired transport. If none is - provided, then the first transport in the registry is used. - - Returns: - The transport class to use. - """ - # If a specific transport is requested, return that one. - if label: - return cls._transport_registry[label] - - # No transport is requested; return the default (that is, the first one - # in the dictionary). - return next(iter(cls._transport_registry.values())) - - -class Controller2Client(metaclass=Controller2ClientMeta): - """The Controller service provides the API for orchestrating a - collection of debugger agents to perform debugging tasks. These - agents are each attached to a process of an application which may - include one or more replicas. - - The debugger agents register with the Controller to identify the - application being debugged, the Debuggee. All agents that register - with the same data, represent the same Debuggee, and are assigned - the same ``debuggee_id``. - - The debugger agents call the Controller to retrieve the list of - active Breakpoints. Agents with the same ``debuggee_id`` get the - same breakpoints list. An agent that can fulfill the breakpoint - request updates the Controller with the breakpoint result. The - controller selects the first result received and discards the rest - of the results. Agents that poll again for active breakpoints will - no longer have the completed breakpoint in the list and should - remove that breakpoint from their attached process. - - The Controller service does not provide a way to retrieve the - results of a completed breakpoint. This functionality is available - using the Debugger service. - """ - - @staticmethod - def _get_default_mtls_endpoint(api_endpoint): - """Converts api endpoint to mTLS endpoint. - - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - DEFAULT_ENDPOINT = "clouddebugger.googleapis.com" - DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore - DEFAULT_ENDPOINT - ) - - @classmethod - def from_service_account_info(cls, info: dict, *args, **kwargs): - """Creates an instance of this client using the provided credentials - info. - - Args: - info (dict): The service account private key info. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - Controller2Client: The constructed client. - """ - credentials = service_account.Credentials.from_service_account_info(info) - kwargs["credentials"] = credentials - return cls(*args, **kwargs) - - @classmethod - def from_service_account_file(cls, filename: str, *args, **kwargs): - """Creates an instance of this client using the provided credentials - file. - - Args: - filename (str): The path to the service account private key json - file. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - Controller2Client: The constructed client. - """ - credentials = service_account.Credentials.from_service_account_file( - filename) - kwargs["credentials"] = credentials - return cls(*args, **kwargs) - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> Controller2Transport: - """Returns the transport used by the client instance. - - Returns: - Controller2Transport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): - """Return the API endpoint and client cert source for mutual TLS. - - The client cert source is determined in the following order: - (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the - client cert source is None. - (2) if `client_options.client_cert_source` is provided, use the provided one; if the - default client cert source exists, use the default one; otherwise the client cert - source is None. - - The API endpoint is determined in the following order: - (1) if `client_options.api_endpoint` if provided, use the provided one. - (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the - default mTLS endpoint; if the environment variabel is "never", use the default API - endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise - use the default API endpoint. - - More details can be found at https://google.aip.dev/auth/4114. - - Args: - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. Only the `api_endpoint` and `client_cert_source` properties may be used - in this method. - - Returns: - Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the - client cert source to use. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If any errors happen. - """ - if client_options is None: - client_options = client_options_lib.ClientOptions() - use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") - use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_client_cert not in ("true", "false"): - raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") - if use_mtls_endpoint not in ("auto", "never", "always"): - raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") - - # Figure out the client cert source to use. - client_cert_source = None - if use_client_cert == "true": - if client_options.client_cert_source: - client_cert_source = client_options.client_cert_source - elif mtls.has_default_client_cert_source(): - client_cert_source = mtls.default_client_cert_source() - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): - api_endpoint = cls.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = cls.DEFAULT_ENDPOINT - - return api_endpoint, client_cert_source - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, Controller2Transport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the controller2 client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Union[str, Controller2Transport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - - api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) - - api_key_value = getattr(client_options, "api_key", None) - if api_key_value and credentials: - raise ValueError("client_options.api_key and credentials are mutually exclusive") - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - if isinstance(transport, Controller2Transport): - # transport is a Controller2Transport instance. - if credentials or client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - import google.auth._default # type: ignore - - if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): - credentials = google.auth._default.get_api_key_credentials(api_key_value) - - Transport = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - ) - - def register_debuggee(self, - request: Union[controller.RegisterDebuggeeRequest, dict] = None, - *, - debuggee: data.Debuggee = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> controller.RegisterDebuggeeResponse: - r"""Registers the debuggee with the controller service. - - All agents attached to the same application must call this - method with exactly the same request content to get back the - same stable ``debuggee_id``. Agents should call this method - again whenever ``google.rpc.Code.NOT_FOUND`` is returned from - any controller method. - - This protocol allows the controller service to disable - debuggees, recover from data loss, or change the ``debuggee_id`` - format. Agents must handle ``debuggee_id`` value changing upon - re-registration. - - Args: - request (Union[google.cloud.debugger_v2.types.RegisterDebuggeeRequest, dict]): - The request object. Request to register a debuggee. - debuggee (google.cloud.debugger_v2.types.Debuggee): - Required. Debuggee information to register. The fields - ``project``, ``uniquifier``, ``description`` and - ``agent_version`` of the debuggee must be set. - - This corresponds to the ``debuggee`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.RegisterDebuggeeResponse: - Response for registering a debuggee. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a controller.RegisterDebuggeeRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, controller.RegisterDebuggeeRequest): - request = controller.RegisterDebuggeeRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee is not None: - request.debuggee = debuggee - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.register_debuggee] - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_active_breakpoints(self, - request: Union[controller.ListActiveBreakpointsRequest, dict] = None, - *, - debuggee_id: str = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> controller.ListActiveBreakpointsResponse: - r"""Returns the list of all active breakpoints for the debuggee. - - The breakpoint specification (``location``, ``condition``, and - ``expressions`` fields) is semantically immutable, although the - field values may change. For example, an agent may update the - location line number to reflect the actual line where the - breakpoint was set, but this doesn't change the breakpoint - semantics. - - This means that an agent does not need to check if a breakpoint - has changed when it encounters the same breakpoint on a - successive call. Moreover, an agent should remember the - breakpoints that are completed until the controller removes them - from the active list to avoid setting those breakpoints again. - - Args: - request (Union[google.cloud.debugger_v2.types.ListActiveBreakpointsRequest, dict]): - The request object. Request to list active breakpoints. - debuggee_id (str): - Required. Identifies the debuggee. - This corresponds to the ``debuggee_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.ListActiveBreakpointsResponse: - Response for listing active - breakpoints. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee_id]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a controller.ListActiveBreakpointsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, controller.ListActiveBreakpointsRequest): - request = controller.ListActiveBreakpointsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee_id is not None: - request.debuggee_id = debuggee_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_active_breakpoints] - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_active_breakpoint(self, - request: Union[controller.UpdateActiveBreakpointRequest, dict] = None, - *, - debuggee_id: str = None, - breakpoint_: data.Breakpoint = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> controller.UpdateActiveBreakpointResponse: - r"""Updates the breakpoint state or mutable fields. The entire - Breakpoint message must be sent back to the controller service. - - Updates to active breakpoint fields are only allowed if the new - value does not change the breakpoint specification. Updates to - the ``location``, ``condition`` and ``expressions`` fields - should not alter the breakpoint semantics. These may only make - changes such as canonicalizing a value or snapping the location - to the correct line of code. - - Args: - request (Union[google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest, dict]): - The request object. Request to update an active - breakpoint. - debuggee_id (str): - Required. Identifies the debuggee - being debugged. - - This corresponds to the ``debuggee_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - breakpoint_ (google.cloud.debugger_v2.types.Breakpoint): - Required. Updated breakpoint information. The field - ``id`` must be set. The agent must echo all Breakpoint - specification fields in the update. - - This corresponds to the ``breakpoint_`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse: - Response for updating an active - breakpoint. The message is defined to - allow future extensions. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee_id, breakpoint_]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a controller.UpdateActiveBreakpointRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, controller.UpdateActiveBreakpointRequest): - request = controller.UpdateActiveBreakpointRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee_id is not None: - request.debuggee_id = debuggee_id - if breakpoint_ is not None: - request.breakpoint_ = breakpoint_ - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.update_active_breakpoint] - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self): - return self - - def __exit__(self, type, value, traceback): - """Releases underlying transport's resources. - - .. warning:: - ONLY use as a context manager if the transport is NOT shared - with other clients! Exiting the with block will CLOSE the transport - and may cause errors in other clients! - """ - self.transport.close() - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-debugger-client", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "Controller2Client", -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py deleted file mode 100644 index d4601b2..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -from collections import OrderedDict -from typing import Dict, Type - -from .base import Controller2Transport -from .grpc import Controller2GrpcTransport -from .grpc_asyncio import Controller2GrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] -_transport_registry['grpc'] = Controller2GrpcTransport -_transport_registry['grpc_asyncio'] = Controller2GrpcAsyncIOTransport - -__all__ = ( - 'Controller2Transport', - 'Controller2GrpcTransport', - 'Controller2GrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py deleted file mode 100644 index d435289..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py +++ /dev/null @@ -1,188 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import abc -from typing import Awaitable, Callable, Dict, Optional, Sequence, Union -import pkg_resources - -import google.auth # type: ignore -import google.api_core -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.debugger_v2.types import controller - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-debugger-client', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -class Controller2Transport(abc.ABC): - """Abstract transport class for Controller2.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud_debugger', - ) - - DEFAULT_HOST: str = 'clouddebugger.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} - - # Save the scopes. - self._scopes = scopes - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - - # If the credentials are service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.register_debuggee: gapic_v1.method.wrap_method( - self.register_debuggee, - default_timeout=600.0, - client_info=client_info, - ), - self.list_active_breakpoints: gapic_v1.method.wrap_method( - self.list_active_breakpoints, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=client_info, - ), - self.update_active_breakpoint: gapic_v1.method.wrap_method( - self.update_active_breakpoint, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=client_info, - ), - } - - def close(self): - """Closes resources associated with the transport. - - .. warning:: - Only call this method if the transport is NOT shared - with other clients - this may cause errors in other clients! - """ - raise NotImplementedError() - - @property - def register_debuggee(self) -> Callable[ - [controller.RegisterDebuggeeRequest], - Union[ - controller.RegisterDebuggeeResponse, - Awaitable[controller.RegisterDebuggeeResponse] - ]]: - raise NotImplementedError() - - @property - def list_active_breakpoints(self) -> Callable[ - [controller.ListActiveBreakpointsRequest], - Union[ - controller.ListActiveBreakpointsResponse, - Awaitable[controller.ListActiveBreakpointsResponse] - ]]: - raise NotImplementedError() - - @property - def update_active_breakpoint(self) -> Callable[ - [controller.UpdateActiveBreakpointRequest], - Union[ - controller.UpdateActiveBreakpointResponse, - Awaitable[controller.UpdateActiveBreakpointResponse] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'Controller2Transport', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py deleted file mode 100644 index 6011f18..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py +++ /dev/null @@ -1,362 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers -from google.api_core import gapic_v1 -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.debugger_v2.types import controller -from .base import Controller2Transport, DEFAULT_CLIENT_INFO - - -class Controller2GrpcTransport(Controller2Transport): - """gRPC backend transport for Controller2. - - The Controller service provides the API for orchestrating a - collection of debugger agents to perform debugging tasks. These - agents are each attached to a process of an application which may - include one or more replicas. - - The debugger agents register with the Controller to identify the - application being debugged, the Debuggee. All agents that register - with the same data, represent the same Debuggee, and are assigned - the same ``debuggee_id``. - - The debugger agents call the Controller to retrieve the list of - active Breakpoints. Agents with the same ``debuggee_id`` get the - same breakpoints list. An agent that can fulfill the breakpoint - request updates the Controller with the breakpoint result. The - controller selects the first result received and discards the rest - of the results. Agents that poll again for active breakpoints will - no longer have the completed breakpoint in the list and should - remove that breakpoint from their attached process. - - The Controller service does not provide a way to retrieve the - results of a completed breakpoint. This functionality is available - using the Debugger service. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - _stubs: Dict[str, Callable] - - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Sequence[str] = None, - channel: grpc.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'clouddebugger.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def register_debuggee(self) -> Callable[ - [controller.RegisterDebuggeeRequest], - controller.RegisterDebuggeeResponse]: - r"""Return a callable for the register debuggee method over gRPC. - - Registers the debuggee with the controller service. - - All agents attached to the same application must call this - method with exactly the same request content to get back the - same stable ``debuggee_id``. Agents should call this method - again whenever ``google.rpc.Code.NOT_FOUND`` is returned from - any controller method. - - This protocol allows the controller service to disable - debuggees, recover from data loss, or change the ``debuggee_id`` - format. Agents must handle ``debuggee_id`` value changing upon - re-registration. - - Returns: - Callable[[~.RegisterDebuggeeRequest], - ~.RegisterDebuggeeResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'register_debuggee' not in self._stubs: - self._stubs['register_debuggee'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Controller2/RegisterDebuggee', - request_serializer=controller.RegisterDebuggeeRequest.serialize, - response_deserializer=controller.RegisterDebuggeeResponse.deserialize, - ) - return self._stubs['register_debuggee'] - - @property - def list_active_breakpoints(self) -> Callable[ - [controller.ListActiveBreakpointsRequest], - controller.ListActiveBreakpointsResponse]: - r"""Return a callable for the list active breakpoints method over gRPC. - - Returns the list of all active breakpoints for the debuggee. - - The breakpoint specification (``location``, ``condition``, and - ``expressions`` fields) is semantically immutable, although the - field values may change. For example, an agent may update the - location line number to reflect the actual line where the - breakpoint was set, but this doesn't change the breakpoint - semantics. - - This means that an agent does not need to check if a breakpoint - has changed when it encounters the same breakpoint on a - successive call. Moreover, an agent should remember the - breakpoints that are completed until the controller removes them - from the active list to avoid setting those breakpoints again. - - Returns: - Callable[[~.ListActiveBreakpointsRequest], - ~.ListActiveBreakpointsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_active_breakpoints' not in self._stubs: - self._stubs['list_active_breakpoints'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Controller2/ListActiveBreakpoints', - request_serializer=controller.ListActiveBreakpointsRequest.serialize, - response_deserializer=controller.ListActiveBreakpointsResponse.deserialize, - ) - return self._stubs['list_active_breakpoints'] - - @property - def update_active_breakpoint(self) -> Callable[ - [controller.UpdateActiveBreakpointRequest], - controller.UpdateActiveBreakpointResponse]: - r"""Return a callable for the update active breakpoint method over gRPC. - - Updates the breakpoint state or mutable fields. The entire - Breakpoint message must be sent back to the controller service. - - Updates to active breakpoint fields are only allowed if the new - value does not change the breakpoint specification. Updates to - the ``location``, ``condition`` and ``expressions`` fields - should not alter the breakpoint semantics. These may only make - changes such as canonicalizing a value or snapping the location - to the correct line of code. - - Returns: - Callable[[~.UpdateActiveBreakpointRequest], - ~.UpdateActiveBreakpointResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_active_breakpoint' not in self._stubs: - self._stubs['update_active_breakpoint'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Controller2/UpdateActiveBreakpoint', - request_serializer=controller.UpdateActiveBreakpointRequest.serialize, - response_deserializer=controller.UpdateActiveBreakpointResponse.deserialize, - ) - return self._stubs['update_active_breakpoint'] - - def close(self): - self.grpc_channel.close() - -__all__ = ( - 'Controller2GrpcTransport', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py deleted file mode 100644 index e60e6ca..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py +++ /dev/null @@ -1,366 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers_async -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.debugger_v2.types import controller -from .base import Controller2Transport, DEFAULT_CLIENT_INFO -from .grpc import Controller2GrpcTransport - - -class Controller2GrpcAsyncIOTransport(Controller2Transport): - """gRPC AsyncIO backend transport for Controller2. - - The Controller service provides the API for orchestrating a - collection of debugger agents to perform debugging tasks. These - agents are each attached to a process of an application which may - include one or more replicas. - - The debugger agents register with the Controller to identify the - application being debugged, the Debuggee. All agents that register - with the same data, represent the same Debuggee, and are assigned - the same ``debuggee_id``. - - The debugger agents call the Controller to retrieve the list of - active Breakpoints. Agents with the same ``debuggee_id`` get the - same breakpoints list. An agent that can fulfill the breakpoint - request updates the Controller with the breakpoint result. The - controller selects the first result received and discards the rest - of the results. Agents that poll again for active breakpoints will - no longer have the completed breakpoint in the list and should - remove that breakpoint from their attached process. - - The Controller service does not provide a way to retrieve the - results of a completed breakpoint. This functionality is available - using the Debugger service. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - - _grpc_channel: aio.Channel - _stubs: Dict[str, Callable] = {} - - @classmethod - def create_channel(cls, - host: str = 'clouddebugger.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: aio.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id=None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[aio.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @property - def grpc_channel(self) -> aio.Channel: - """Create the channel designed to connect to this service. - - This property caches on the instance; repeated calls return - the same channel. - """ - # Return the channel from cache. - return self._grpc_channel - - @property - def register_debuggee(self) -> Callable[ - [controller.RegisterDebuggeeRequest], - Awaitable[controller.RegisterDebuggeeResponse]]: - r"""Return a callable for the register debuggee method over gRPC. - - Registers the debuggee with the controller service. - - All agents attached to the same application must call this - method with exactly the same request content to get back the - same stable ``debuggee_id``. Agents should call this method - again whenever ``google.rpc.Code.NOT_FOUND`` is returned from - any controller method. - - This protocol allows the controller service to disable - debuggees, recover from data loss, or change the ``debuggee_id`` - format. Agents must handle ``debuggee_id`` value changing upon - re-registration. - - Returns: - Callable[[~.RegisterDebuggeeRequest], - Awaitable[~.RegisterDebuggeeResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'register_debuggee' not in self._stubs: - self._stubs['register_debuggee'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Controller2/RegisterDebuggee', - request_serializer=controller.RegisterDebuggeeRequest.serialize, - response_deserializer=controller.RegisterDebuggeeResponse.deserialize, - ) - return self._stubs['register_debuggee'] - - @property - def list_active_breakpoints(self) -> Callable[ - [controller.ListActiveBreakpointsRequest], - Awaitable[controller.ListActiveBreakpointsResponse]]: - r"""Return a callable for the list active breakpoints method over gRPC. - - Returns the list of all active breakpoints for the debuggee. - - The breakpoint specification (``location``, ``condition``, and - ``expressions`` fields) is semantically immutable, although the - field values may change. For example, an agent may update the - location line number to reflect the actual line where the - breakpoint was set, but this doesn't change the breakpoint - semantics. - - This means that an agent does not need to check if a breakpoint - has changed when it encounters the same breakpoint on a - successive call. Moreover, an agent should remember the - breakpoints that are completed until the controller removes them - from the active list to avoid setting those breakpoints again. - - Returns: - Callable[[~.ListActiveBreakpointsRequest], - Awaitable[~.ListActiveBreakpointsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_active_breakpoints' not in self._stubs: - self._stubs['list_active_breakpoints'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Controller2/ListActiveBreakpoints', - request_serializer=controller.ListActiveBreakpointsRequest.serialize, - response_deserializer=controller.ListActiveBreakpointsResponse.deserialize, - ) - return self._stubs['list_active_breakpoints'] - - @property - def update_active_breakpoint(self) -> Callable[ - [controller.UpdateActiveBreakpointRequest], - Awaitable[controller.UpdateActiveBreakpointResponse]]: - r"""Return a callable for the update active breakpoint method over gRPC. - - Updates the breakpoint state or mutable fields. The entire - Breakpoint message must be sent back to the controller service. - - Updates to active breakpoint fields are only allowed if the new - value does not change the breakpoint specification. Updates to - the ``location``, ``condition`` and ``expressions`` fields - should not alter the breakpoint semantics. These may only make - changes such as canonicalizing a value or snapping the location - to the correct line of code. - - Returns: - Callable[[~.UpdateActiveBreakpointRequest], - Awaitable[~.UpdateActiveBreakpointResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'update_active_breakpoint' not in self._stubs: - self._stubs['update_active_breakpoint'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Controller2/UpdateActiveBreakpoint', - request_serializer=controller.UpdateActiveBreakpointRequest.serialize, - response_deserializer=controller.UpdateActiveBreakpointResponse.deserialize, - ) - return self._stubs['update_active_breakpoint'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'Controller2GrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py deleted file mode 100644 index ed82703..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -from .client import Debugger2Client -from .async_client import Debugger2AsyncClient - -__all__ = ( - 'Debugger2Client', - 'Debugger2AsyncClient', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py deleted file mode 100644 index 65a6866..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py +++ /dev/null @@ -1,644 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -from collections import OrderedDict -import functools -import re -from typing import Dict, Optional, Sequence, Tuple, Type, Union -import pkg_resources - -from google.api_core.client_options import ClientOptions -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.cloud.debugger_v2.types import data -from google.cloud.debugger_v2.types import debugger -from .transports.base import Debugger2Transport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import Debugger2GrpcAsyncIOTransport -from .client import Debugger2Client - - -class Debugger2AsyncClient: - """The Debugger service provides the API that allows users to - collect run-time information from a running application, without - stopping or slowing it down and without modifying its state. An - application may include one or more replicated processes - performing the same work. - A debugged application is represented using the Debuggee - concept. The Debugger service provides a way to query for - available debuggees, but does not provide a way to create one. - A debuggee is created using the Controller service, usually by - running a debugger agent with the application. - The Debugger service enables the client to set one or more - Breakpoints on a Debuggee and collect the results of the set - Breakpoints. - """ - - _client: Debugger2Client - - DEFAULT_ENDPOINT = Debugger2Client.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = Debugger2Client.DEFAULT_MTLS_ENDPOINT - - common_billing_account_path = staticmethod(Debugger2Client.common_billing_account_path) - parse_common_billing_account_path = staticmethod(Debugger2Client.parse_common_billing_account_path) - common_folder_path = staticmethod(Debugger2Client.common_folder_path) - parse_common_folder_path = staticmethod(Debugger2Client.parse_common_folder_path) - common_organization_path = staticmethod(Debugger2Client.common_organization_path) - parse_common_organization_path = staticmethod(Debugger2Client.parse_common_organization_path) - common_project_path = staticmethod(Debugger2Client.common_project_path) - parse_common_project_path = staticmethod(Debugger2Client.parse_common_project_path) - common_location_path = staticmethod(Debugger2Client.common_location_path) - parse_common_location_path = staticmethod(Debugger2Client.parse_common_location_path) - - @classmethod - def from_service_account_info(cls, info: dict, *args, **kwargs): - """Creates an instance of this client using the provided credentials - info. - - Args: - info (dict): The service account private key info. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - Debugger2AsyncClient: The constructed client. - """ - return Debugger2Client.from_service_account_info.__func__(Debugger2AsyncClient, info, *args, **kwargs) # type: ignore - - @classmethod - def from_service_account_file(cls, filename: str, *args, **kwargs): - """Creates an instance of this client using the provided credentials - file. - - Args: - filename (str): The path to the service account private key json - file. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - Debugger2AsyncClient: The constructed client. - """ - return Debugger2Client.from_service_account_file.__func__(Debugger2AsyncClient, filename, *args, **kwargs) # type: ignore - - from_service_account_json = from_service_account_file - - @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[ClientOptions] = None): - """Return the API endpoint and client cert source for mutual TLS. - - The client cert source is determined in the following order: - (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the - client cert source is None. - (2) if `client_options.client_cert_source` is provided, use the provided one; if the - default client cert source exists, use the default one; otherwise the client cert - source is None. - - The API endpoint is determined in the following order: - (1) if `client_options.api_endpoint` if provided, use the provided one. - (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the - default mTLS endpoint; if the environment variabel is "never", use the default API - endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise - use the default API endpoint. - - More details can be found at https://google.aip.dev/auth/4114. - - Args: - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. Only the `api_endpoint` and `client_cert_source` properties may be used - in this method. - - Returns: - Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the - client cert source to use. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If any errors happen. - """ - return Debugger2Client.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> Debugger2Transport: - """Returns the transport used by the client instance. - - Returns: - Debugger2Transport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(Debugger2Client).get_transport_class, type(Debugger2Client)) - - def __init__(self, *, - credentials: ga_credentials.Credentials = None, - transport: Union[str, Debugger2Transport] = "grpc_asyncio", - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the debugger2 client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Union[str, ~.Debugger2Transport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (ClientOptions): Custom options for the client. It - won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - """ - self._client = Debugger2Client( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def set_breakpoint(self, - request: Union[debugger.SetBreakpointRequest, dict] = None, - *, - debuggee_id: str = None, - breakpoint_: data.Breakpoint = None, - client_version: str = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.SetBreakpointResponse: - r"""Sets the breakpoint to the debuggee. - - Args: - request (Union[google.cloud.debugger_v2.types.SetBreakpointRequest, dict]): - The request object. Request to set a breakpoint - debuggee_id (:class:`str`): - Required. ID of the debuggee where - the breakpoint is to be set. - - This corresponds to the ``debuggee_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - breakpoint_ (:class:`google.cloud.debugger_v2.types.Breakpoint`): - Required. Breakpoint specification to set. The field - ``location`` of the breakpoint must be set. - - This corresponds to the ``breakpoint_`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - client_version (:class:`str`): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., - ``google.com/intellij/v1``). - - This corresponds to the ``client_version`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.SetBreakpointResponse: - Response for setting a breakpoint. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee_id, breakpoint_, client_version]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = debugger.SetBreakpointRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee_id is not None: - request.debuggee_id = debuggee_id - if breakpoint_ is not None: - request.breakpoint_ = breakpoint_ - if client_version is not None: - request.client_version = client_version - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.set_breakpoint, - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_breakpoint(self, - request: Union[debugger.GetBreakpointRequest, dict] = None, - *, - debuggee_id: str = None, - breakpoint_id: str = None, - client_version: str = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.GetBreakpointResponse: - r"""Gets breakpoint information. - - Args: - request (Union[google.cloud.debugger_v2.types.GetBreakpointRequest, dict]): - The request object. Request to get breakpoint - information. - debuggee_id (:class:`str`): - Required. ID of the debuggee whose - breakpoint to get. - - This corresponds to the ``debuggee_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - breakpoint_id (:class:`str`): - Required. ID of the breakpoint to - get. - - This corresponds to the ``breakpoint_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - client_version (:class:`str`): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., - ``google.com/intellij/v1``). - - This corresponds to the ``client_version`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.GetBreakpointResponse: - Response for getting breakpoint - information. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee_id, breakpoint_id, client_version]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = debugger.GetBreakpointRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee_id is not None: - request.debuggee_id = debuggee_id - if breakpoint_id is not None: - request.breakpoint_id = breakpoint_id - if client_version is not None: - request.client_version = client_version - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.get_breakpoint, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_breakpoint(self, - request: Union[debugger.DeleteBreakpointRequest, dict] = None, - *, - debuggee_id: str = None, - breakpoint_id: str = None, - client_version: str = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the breakpoint from the debuggee. - - Args: - request (Union[google.cloud.debugger_v2.types.DeleteBreakpointRequest, dict]): - The request object. Request to delete a breakpoint. - debuggee_id (:class:`str`): - Required. ID of the debuggee whose - breakpoint to delete. - - This corresponds to the ``debuggee_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - breakpoint_id (:class:`str`): - Required. ID of the breakpoint to - delete. - - This corresponds to the ``breakpoint_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - client_version (:class:`str`): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., - ``google.com/intellij/v1``). - - This corresponds to the ``client_version`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee_id, breakpoint_id, client_version]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = debugger.DeleteBreakpointRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee_id is not None: - request.debuggee_id = debuggee_id - if breakpoint_id is not None: - request.breakpoint_id = breakpoint_id - if client_version is not None: - request.client_version = client_version - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.delete_breakpoint, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def list_breakpoints(self, - request: Union[debugger.ListBreakpointsRequest, dict] = None, - *, - debuggee_id: str = None, - client_version: str = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListBreakpointsResponse: - r"""Lists all breakpoints for the debuggee. - - Args: - request (Union[google.cloud.debugger_v2.types.ListBreakpointsRequest, dict]): - The request object. Request to list breakpoints. - debuggee_id (:class:`str`): - Required. ID of the debuggee whose - breakpoints to list. - - This corresponds to the ``debuggee_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - client_version (:class:`str`): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., - ``google.com/intellij/v1``). - - This corresponds to the ``client_version`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.ListBreakpointsResponse: - Response for listing breakpoints. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee_id, client_version]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = debugger.ListBreakpointsRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee_id is not None: - request.debuggee_id = debuggee_id - if client_version is not None: - request.client_version = client_version - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_breakpoints, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def list_debuggees(self, - request: Union[debugger.ListDebuggeesRequest, dict] = None, - *, - project: str = None, - client_version: str = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListDebuggeesResponse: - r"""Lists all the debuggees that the user has access to. - - Args: - request (Union[google.cloud.debugger_v2.types.ListDebuggeesRequest, dict]): - The request object. Request to list debuggees. - project (:class:`str`): - Required. Project number of a Google - Cloud project whose debuggees to list. - - This corresponds to the ``project`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - client_version (:class:`str`): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., - ``google.com/intellij/v1``). - - This corresponds to the ``client_version`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.ListDebuggeesResponse: - Response for listing debuggees. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([project, client_version]) - if request is not None and has_flattened_params: - raise ValueError("If the `request` argument is set, then none of " - "the individual field arguments should be set.") - - request = debugger.ListDebuggeesRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if project is not None: - request.project = project - if client_version is not None: - request.client_version = client_version - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = gapic_v1.method_async.wrap_method( - self._client._transport.list_debuggees, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self): - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-debugger-client", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "Debugger2AsyncClient", -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py deleted file mode 100644 index ce6b5fb..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py +++ /dev/null @@ -1,803 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -from collections import OrderedDict -import os -import re -from typing import Dict, Optional, Sequence, Tuple, Type, Union -import pkg_resources - -from google.api_core import client_options as client_options_lib -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport import mtls # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth.exceptions import MutualTLSChannelError # type: ignore -from google.oauth2 import service_account # type: ignore - -try: - OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object] # type: ignore - -from google.cloud.debugger_v2.types import data -from google.cloud.debugger_v2.types import debugger -from .transports.base import Debugger2Transport, DEFAULT_CLIENT_INFO -from .transports.grpc import Debugger2GrpcTransport -from .transports.grpc_asyncio import Debugger2GrpcAsyncIOTransport - - -class Debugger2ClientMeta(type): - """Metaclass for the Debugger2 client. - - This provides class-level methods for building and retrieving - support objects (e.g. transport) without polluting the client instance - objects. - """ - _transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] - _transport_registry["grpc"] = Debugger2GrpcTransport - _transport_registry["grpc_asyncio"] = Debugger2GrpcAsyncIOTransport - - def get_transport_class(cls, - label: str = None, - ) -> Type[Debugger2Transport]: - """Returns an appropriate transport class. - - Args: - label: The name of the desired transport. If none is - provided, then the first transport in the registry is used. - - Returns: - The transport class to use. - """ - # If a specific transport is requested, return that one. - if label: - return cls._transport_registry[label] - - # No transport is requested; return the default (that is, the first one - # in the dictionary). - return next(iter(cls._transport_registry.values())) - - -class Debugger2Client(metaclass=Debugger2ClientMeta): - """The Debugger service provides the API that allows users to - collect run-time information from a running application, without - stopping or slowing it down and without modifying its state. An - application may include one or more replicated processes - performing the same work. - A debugged application is represented using the Debuggee - concept. The Debugger service provides a way to query for - available debuggees, but does not provide a way to create one. - A debuggee is created using the Controller service, usually by - running a debugger agent with the application. - The Debugger service enables the client to set one or more - Breakpoints on a Debuggee and collect the results of the set - Breakpoints. - """ - - @staticmethod - def _get_default_mtls_endpoint(api_endpoint): - """Converts api endpoint to mTLS endpoint. - - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - DEFAULT_ENDPOINT = "clouddebugger.googleapis.com" - DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore - DEFAULT_ENDPOINT - ) - - @classmethod - def from_service_account_info(cls, info: dict, *args, **kwargs): - """Creates an instance of this client using the provided credentials - info. - - Args: - info (dict): The service account private key info. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - Debugger2Client: The constructed client. - """ - credentials = service_account.Credentials.from_service_account_info(info) - kwargs["credentials"] = credentials - return cls(*args, **kwargs) - - @classmethod - def from_service_account_file(cls, filename: str, *args, **kwargs): - """Creates an instance of this client using the provided credentials - file. - - Args: - filename (str): The path to the service account private key json - file. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - Debugger2Client: The constructed client. - """ - credentials = service_account.Credentials.from_service_account_file( - filename) - kwargs["credentials"] = credentials - return cls(*args, **kwargs) - - from_service_account_json = from_service_account_file - - @property - def transport(self) -> Debugger2Transport: - """Returns the transport used by the client instance. - - Returns: - Debugger2Transport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def common_billing_account_path(billing_account: str, ) -> str: - """Returns a fully-qualified billing_account string.""" - return "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - - @staticmethod - def parse_common_billing_account_path(path: str) -> Dict[str,str]: - """Parse a billing_account path into its component segments.""" - m = re.match(r"^billingAccounts/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_folder_path(folder: str, ) -> str: - """Returns a fully-qualified folder string.""" - return "folders/{folder}".format(folder=folder, ) - - @staticmethod - def parse_common_folder_path(path: str) -> Dict[str,str]: - """Parse a folder path into its component segments.""" - m = re.match(r"^folders/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_organization_path(organization: str, ) -> str: - """Returns a fully-qualified organization string.""" - return "organizations/{organization}".format(organization=organization, ) - - @staticmethod - def parse_common_organization_path(path: str) -> Dict[str,str]: - """Parse a organization path into its component segments.""" - m = re.match(r"^organizations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_project_path(project: str, ) -> str: - """Returns a fully-qualified project string.""" - return "projects/{project}".format(project=project, ) - - @staticmethod - def parse_common_project_path(path: str) -> Dict[str,str]: - """Parse a project path into its component segments.""" - m = re.match(r"^projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def common_location_path(project: str, location: str, ) -> str: - """Returns a fully-qualified location string.""" - return "projects/{project}/locations/{location}".format(project=project, location=location, ) - - @staticmethod - def parse_common_location_path(path: str) -> Dict[str,str]: - """Parse a location path into its component segments.""" - m = re.match(r"^projects/(?P.+?)/locations/(?P.+?)$", path) - return m.groupdict() if m else {} - - @classmethod - def get_mtls_endpoint_and_cert_source(cls, client_options: Optional[client_options_lib.ClientOptions] = None): - """Return the API endpoint and client cert source for mutual TLS. - - The client cert source is determined in the following order: - (1) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is not "true", the - client cert source is None. - (2) if `client_options.client_cert_source` is provided, use the provided one; if the - default client cert source exists, use the default one; otherwise the client cert - source is None. - - The API endpoint is determined in the following order: - (1) if `client_options.api_endpoint` if provided, use the provided one. - (2) if `GOOGLE_API_USE_CLIENT_CERTIFICATE` environment variable is "always", use the - default mTLS endpoint; if the environment variabel is "never", use the default API - endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise - use the default API endpoint. - - More details can be found at https://google.aip.dev/auth/4114. - - Args: - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. Only the `api_endpoint` and `client_cert_source` properties may be used - in this method. - - Returns: - Tuple[str, Callable[[], Tuple[bytes, bytes]]]: returns the API endpoint and the - client cert source to use. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If any errors happen. - """ - if client_options is None: - client_options = client_options_lib.ClientOptions() - use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") - use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_client_cert not in ("true", "false"): - raise ValueError("Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`") - if use_mtls_endpoint not in ("auto", "never", "always"): - raise MutualTLSChannelError("Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`") - - # Figure out the client cert source to use. - client_cert_source = None - if use_client_cert == "true": - if client_options.client_cert_source: - client_cert_source = client_options.client_cert_source - elif mtls.has_default_client_cert_source(): - client_cert_source = mtls.default_client_cert_source() - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): - api_endpoint = cls.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = cls.DEFAULT_ENDPOINT - - return api_endpoint, client_cert_source - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Union[str, Debugger2Transport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the debugger2 client. - - Args: - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - transport (Union[str, Debugger2Transport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - - api_endpoint, client_cert_source_func = self.get_mtls_endpoint_and_cert_source(client_options) - - api_key_value = getattr(client_options, "api_key", None) - if api_key_value and credentials: - raise ValueError("client_options.api_key and credentials are mutually exclusive") - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - if isinstance(transport, Debugger2Transport): - # transport is a Debugger2Transport instance. - if credentials or client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = transport - else: - import google.auth._default # type: ignore - - if api_key_value and hasattr(google.auth._default, "get_api_key_credentials"): - credentials = google.auth._default.get_api_key_credentials(api_key_value) - - Transport = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - ) - - def set_breakpoint(self, - request: Union[debugger.SetBreakpointRequest, dict] = None, - *, - debuggee_id: str = None, - breakpoint_: data.Breakpoint = None, - client_version: str = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.SetBreakpointResponse: - r"""Sets the breakpoint to the debuggee. - - Args: - request (Union[google.cloud.debugger_v2.types.SetBreakpointRequest, dict]): - The request object. Request to set a breakpoint - debuggee_id (str): - Required. ID of the debuggee where - the breakpoint is to be set. - - This corresponds to the ``debuggee_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - breakpoint_ (google.cloud.debugger_v2.types.Breakpoint): - Required. Breakpoint specification to set. The field - ``location`` of the breakpoint must be set. - - This corresponds to the ``breakpoint_`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - client_version (str): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., - ``google.com/intellij/v1``). - - This corresponds to the ``client_version`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.SetBreakpointResponse: - Response for setting a breakpoint. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee_id, breakpoint_, client_version]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a debugger.SetBreakpointRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, debugger.SetBreakpointRequest): - request = debugger.SetBreakpointRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee_id is not None: - request.debuggee_id = debuggee_id - if breakpoint_ is not None: - request.breakpoint_ = breakpoint_ - if client_version is not None: - request.client_version = client_version - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.set_breakpoint] - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_breakpoint(self, - request: Union[debugger.GetBreakpointRequest, dict] = None, - *, - debuggee_id: str = None, - breakpoint_id: str = None, - client_version: str = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.GetBreakpointResponse: - r"""Gets breakpoint information. - - Args: - request (Union[google.cloud.debugger_v2.types.GetBreakpointRequest, dict]): - The request object. Request to get breakpoint - information. - debuggee_id (str): - Required. ID of the debuggee whose - breakpoint to get. - - This corresponds to the ``debuggee_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - breakpoint_id (str): - Required. ID of the breakpoint to - get. - - This corresponds to the ``breakpoint_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - client_version (str): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., - ``google.com/intellij/v1``). - - This corresponds to the ``client_version`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.GetBreakpointResponse: - Response for getting breakpoint - information. - - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee_id, breakpoint_id, client_version]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a debugger.GetBreakpointRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, debugger.GetBreakpointRequest): - request = debugger.GetBreakpointRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee_id is not None: - request.debuggee_id = debuggee_id - if breakpoint_id is not None: - request.breakpoint_id = breakpoint_id - if client_version is not None: - request.client_version = client_version - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_breakpoint] - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_breakpoint(self, - request: Union[debugger.DeleteBreakpointRequest, dict] = None, - *, - debuggee_id: str = None, - breakpoint_id: str = None, - client_version: str = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the breakpoint from the debuggee. - - Args: - request (Union[google.cloud.debugger_v2.types.DeleteBreakpointRequest, dict]): - The request object. Request to delete a breakpoint. - debuggee_id (str): - Required. ID of the debuggee whose - breakpoint to delete. - - This corresponds to the ``debuggee_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - breakpoint_id (str): - Required. ID of the breakpoint to - delete. - - This corresponds to the ``breakpoint_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - client_version (str): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., - ``google.com/intellij/v1``). - - This corresponds to the ``client_version`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee_id, breakpoint_id, client_version]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a debugger.DeleteBreakpointRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, debugger.DeleteBreakpointRequest): - request = debugger.DeleteBreakpointRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee_id is not None: - request.debuggee_id = debuggee_id - if breakpoint_id is not None: - request.breakpoint_id = breakpoint_id - if client_version is not None: - request.client_version = client_version - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.delete_breakpoint] - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def list_breakpoints(self, - request: Union[debugger.ListBreakpointsRequest, dict] = None, - *, - debuggee_id: str = None, - client_version: str = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListBreakpointsResponse: - r"""Lists all breakpoints for the debuggee. - - Args: - request (Union[google.cloud.debugger_v2.types.ListBreakpointsRequest, dict]): - The request object. Request to list breakpoints. - debuggee_id (str): - Required. ID of the debuggee whose - breakpoints to list. - - This corresponds to the ``debuggee_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - client_version (str): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., - ``google.com/intellij/v1``). - - This corresponds to the ``client_version`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.ListBreakpointsResponse: - Response for listing breakpoints. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([debuggee_id, client_version]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a debugger.ListBreakpointsRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, debugger.ListBreakpointsRequest): - request = debugger.ListBreakpointsRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if debuggee_id is not None: - request.debuggee_id = debuggee_id - if client_version is not None: - request.client_version = client_version - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_breakpoints] - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_debuggees(self, - request: Union[debugger.ListDebuggeesRequest, dict] = None, - *, - project: str = None, - client_version: str = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListDebuggeesResponse: - r"""Lists all the debuggees that the user has access to. - - Args: - request (Union[google.cloud.debugger_v2.types.ListDebuggeesRequest, dict]): - The request object. Request to list debuggees. - project (str): - Required. Project number of a Google - Cloud project whose debuggees to list. - - This corresponds to the ``project`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - client_version (str): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., - ``google.com/intellij/v1``). - - This corresponds to the ``client_version`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be retried. - timeout (float): The timeout for this request. - metadata (Sequence[Tuple[str, str]]): Strings which should be - sent along with the request as metadata. - - Returns: - google.cloud.debugger_v2.types.ListDebuggeesResponse: - Response for listing debuggees. - """ - # Create or coerce a protobuf request object. - # Quick check: If we got a request object, we should *not* have - # gotten any keyword arguments that map to the request. - has_flattened_params = any([project, client_version]) - if request is not None and has_flattened_params: - raise ValueError('If the `request` argument is set, then none of ' - 'the individual field arguments should be set.') - - # Minor optimization to avoid making a copy if the user passes - # in a debugger.ListDebuggeesRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - if not isinstance(request, debugger.ListDebuggeesRequest): - request = debugger.ListDebuggeesRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if project is not None: - request.project = project - if client_version is not None: - request.client_version = client_version - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.list_debuggees] - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self): - return self - - def __exit__(self, type, value, traceback): - """Releases underlying transport's resources. - - .. warning:: - ONLY use as a context manager if the transport is NOT shared - with other clients! Exiting the with block will CLOSE the transport - and may cause errors in other clients! - """ - self.transport.close() - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - "google-cloud-debugger-client", - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - "Debugger2Client", -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py deleted file mode 100644 index 1dc29ef..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py +++ /dev/null @@ -1,33 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -from collections import OrderedDict -from typing import Dict, Type - -from .base import Debugger2Transport -from .grpc import Debugger2GrpcTransport -from .grpc_asyncio import Debugger2GrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] -_transport_registry['grpc'] = Debugger2GrpcTransport -_transport_registry['grpc_asyncio'] = Debugger2GrpcAsyncIOTransport - -__all__ = ( - 'Debugger2Transport', - 'Debugger2GrpcTransport', - 'Debugger2GrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py deleted file mode 100644 index d9fa8de..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py +++ /dev/null @@ -1,231 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import abc -from typing import Awaitable, Callable, Dict, Optional, Sequence, Union -import pkg_resources - -import google.auth # type: ignore -import google.api_core -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import retry as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.debugger_v2.types import debugger -from google.protobuf import empty_pb2 # type: ignore - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-debugger-client', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -class Debugger2Transport(abc.ABC): - """Abstract transport class for Debugger2.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud_debugger', - ) - - DEFAULT_HOST: str = 'clouddebugger.googleapis.com' - def __init__( - self, *, - host: str = DEFAULT_HOST, - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A list of scopes. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - """ - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - scopes_kwargs = {"scopes": scopes, "default_scopes": self.AUTH_SCOPES} - - # Save the scopes. - self._scopes = scopes - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise core_exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = google.auth.load_credentials_from_file( - credentials_file, - **scopes_kwargs, - quota_project_id=quota_project_id - ) - elif credentials is None: - credentials, _ = google.auth.default(**scopes_kwargs, quota_project_id=quota_project_id) - - # If the credentials are service account credentials, then always try to use self signed JWT. - if always_use_jwt_access and isinstance(credentials, service_account.Credentials) and hasattr(service_account.Credentials, "with_always_use_jwt_access"): - credentials = credentials.with_always_use_jwt_access(True) - - # Save the credentials. - self._credentials = credentials - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.set_breakpoint: gapic_v1.method.wrap_method( - self.set_breakpoint, - default_timeout=600.0, - client_info=client_info, - ), - self.get_breakpoint: gapic_v1.method.wrap_method( - self.get_breakpoint, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=client_info, - ), - self.delete_breakpoint: gapic_v1.method.wrap_method( - self.delete_breakpoint, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=client_info, - ), - self.list_breakpoints: gapic_v1.method.wrap_method( - self.list_breakpoints, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=client_info, - ), - self.list_debuggees: gapic_v1.method.wrap_method( - self.list_debuggees, - default_retry=retries.Retry( -initial=0.1,maximum=60.0,multiplier=1.3, predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=600.0, - ), - default_timeout=600.0, - client_info=client_info, - ), - } - - def close(self): - """Closes resources associated with the transport. - - .. warning:: - Only call this method if the transport is NOT shared - with other clients - this may cause errors in other clients! - """ - raise NotImplementedError() - - @property - def set_breakpoint(self) -> Callable[ - [debugger.SetBreakpointRequest], - Union[ - debugger.SetBreakpointResponse, - Awaitable[debugger.SetBreakpointResponse] - ]]: - raise NotImplementedError() - - @property - def get_breakpoint(self) -> Callable[ - [debugger.GetBreakpointRequest], - Union[ - debugger.GetBreakpointResponse, - Awaitable[debugger.GetBreakpointResponse] - ]]: - raise NotImplementedError() - - @property - def delete_breakpoint(self) -> Callable[ - [debugger.DeleteBreakpointRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def list_breakpoints(self) -> Callable[ - [debugger.ListBreakpointsRequest], - Union[ - debugger.ListBreakpointsResponse, - Awaitable[debugger.ListBreakpointsResponse] - ]]: - raise NotImplementedError() - - @property - def list_debuggees(self) -> Callable[ - [debugger.ListDebuggeesRequest], - Union[ - debugger.ListDebuggeesResponse, - Awaitable[debugger.ListDebuggeesResponse] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'Debugger2Transport', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py deleted file mode 100644 index 38edbff..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py +++ /dev/null @@ -1,374 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import grpc_helpers -from google.api_core import gapic_v1 -import google.auth # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.debugger_v2.types import debugger -from google.protobuf import empty_pb2 # type: ignore -from .base import Debugger2Transport, DEFAULT_CLIENT_INFO - - -class Debugger2GrpcTransport(Debugger2Transport): - """gRPC backend transport for Debugger2. - - The Debugger service provides the API that allows users to - collect run-time information from a running application, without - stopping or slowing it down and without modifying its state. An - application may include one or more replicated processes - performing the same work. - A debugged application is represented using the Debuggee - concept. The Debugger service provides a way to query for - available debuggees, but does not provide a way to create one. - A debuggee is created using the Controller service, usually by - running a debugger agent with the application. - The Debugger service enables the client to set one or more - Breakpoints on a Debuggee and collect the results of the set - Breakpoints. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - _stubs: Dict[str, Callable] - - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Sequence[str] = None, - channel: grpc.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @classmethod - def create_channel(cls, - host: str = 'clouddebugger.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: str = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def set_breakpoint(self) -> Callable[ - [debugger.SetBreakpointRequest], - debugger.SetBreakpointResponse]: - r"""Return a callable for the set breakpoint method over gRPC. - - Sets the breakpoint to the debuggee. - - Returns: - Callable[[~.SetBreakpointRequest], - ~.SetBreakpointResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'set_breakpoint' not in self._stubs: - self._stubs['set_breakpoint'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Debugger2/SetBreakpoint', - request_serializer=debugger.SetBreakpointRequest.serialize, - response_deserializer=debugger.SetBreakpointResponse.deserialize, - ) - return self._stubs['set_breakpoint'] - - @property - def get_breakpoint(self) -> Callable[ - [debugger.GetBreakpointRequest], - debugger.GetBreakpointResponse]: - r"""Return a callable for the get breakpoint method over gRPC. - - Gets breakpoint information. - - Returns: - Callable[[~.GetBreakpointRequest], - ~.GetBreakpointResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'get_breakpoint' not in self._stubs: - self._stubs['get_breakpoint'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Debugger2/GetBreakpoint', - request_serializer=debugger.GetBreakpointRequest.serialize, - response_deserializer=debugger.GetBreakpointResponse.deserialize, - ) - return self._stubs['get_breakpoint'] - - @property - def delete_breakpoint(self) -> Callable[ - [debugger.DeleteBreakpointRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete breakpoint method over gRPC. - - Deletes the breakpoint from the debuggee. - - Returns: - Callable[[~.DeleteBreakpointRequest], - ~.Empty]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_breakpoint' not in self._stubs: - self._stubs['delete_breakpoint'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Debugger2/DeleteBreakpoint', - request_serializer=debugger.DeleteBreakpointRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_breakpoint'] - - @property - def list_breakpoints(self) -> Callable[ - [debugger.ListBreakpointsRequest], - debugger.ListBreakpointsResponse]: - r"""Return a callable for the list breakpoints method over gRPC. - - Lists all breakpoints for the debuggee. - - Returns: - Callable[[~.ListBreakpointsRequest], - ~.ListBreakpointsResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_breakpoints' not in self._stubs: - self._stubs['list_breakpoints'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Debugger2/ListBreakpoints', - request_serializer=debugger.ListBreakpointsRequest.serialize, - response_deserializer=debugger.ListBreakpointsResponse.deserialize, - ) - return self._stubs['list_breakpoints'] - - @property - def list_debuggees(self) -> Callable[ - [debugger.ListDebuggeesRequest], - debugger.ListDebuggeesResponse]: - r"""Return a callable for the list debuggees method over gRPC. - - Lists all the debuggees that the user has access to. - - Returns: - Callable[[~.ListDebuggeesRequest], - ~.ListDebuggeesResponse]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_debuggees' not in self._stubs: - self._stubs['list_debuggees'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Debugger2/ListDebuggees', - request_serializer=debugger.ListDebuggeesRequest.serialize, - response_deserializer=debugger.ListDebuggeesResponse.deserialize, - ) - return self._stubs['list_debuggees'] - - def close(self): - self.grpc_channel.close() - -__all__ = ( - 'Debugger2GrpcTransport', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py deleted file mode 100644 index 66ac586..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py +++ /dev/null @@ -1,378 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union - -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers_async -from google.auth import credentials as ga_credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore -from grpc.experimental import aio # type: ignore - -from google.cloud.debugger_v2.types import debugger -from google.protobuf import empty_pb2 # type: ignore -from .base import Debugger2Transport, DEFAULT_CLIENT_INFO -from .grpc import Debugger2GrpcTransport - - -class Debugger2GrpcAsyncIOTransport(Debugger2Transport): - """gRPC AsyncIO backend transport for Debugger2. - - The Debugger service provides the API that allows users to - collect run-time information from a running application, without - stopping or slowing it down and without modifying its state. An - application may include one or more replicated processes - performing the same work. - A debugged application is represented using the Debuggee - concept. The Debugger service provides a way to query for - available debuggees, but does not provide a way to create one. - A debuggee is created using the Controller service, usually by - running a debugger agent with the application. - The Debugger service enables the client to set one or more - Breakpoints on a Debuggee and collect the results of the set - Breakpoints. - - This class defines the same methods as the primary client, so the - primary client can load the underlying transport implementation - and call it. - - It sends protocol buffers over the wire using gRPC (which is built on - top of HTTP/2); the ``grpcio`` package must be installed. - """ - - _grpc_channel: aio.Channel - _stubs: Dict[str, Callable] = {} - - @classmethod - def create_channel(cls, - host: str = 'clouddebugger.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - quota_project_id=quota_project_id, - default_scopes=cls.AUTH_SCOPES, - scopes=scopes, - default_host=cls.DEFAULT_HOST, - **kwargs - ) - - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: ga_credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: aio.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id=None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - always_use_jwt_access: Optional[bool] = False, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[aio.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or application default SSL credentials. - client_cert_source (Optional[Callable[[], Tuple[bytes, bytes]]]): - Deprecated. A callback to provide client SSL certificate bytes and - private key bytes, both in PEM format. It is ignored if - ``api_mtls_endpoint`` is None. - ssl_channel_credentials (grpc.ChannelCredentials): SSL credentials - for the grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure a mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - # use the credentials which are saved - credentials=self._credentials, - # Set ``credentials_file`` to ``None`` here as - # the credentials that we saved earlier should be used. - credentials_file=None, - scopes=self._scopes, - ssl_credentials=self._ssl_channel_credentials, - quota_project_id=quota_project_id, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Wrap messages. This must be done after self._grpc_channel exists - self._prep_wrapped_messages(client_info) - - @property - def grpc_channel(self) -> aio.Channel: - """Create the channel designed to connect to this service. - - This property caches on the instance; repeated calls return - the same channel. - """ - # Return the channel from cache. - return self._grpc_channel - - @property - def set_breakpoint(self) -> Callable[ - [debugger.SetBreakpointRequest], - Awaitable[debugger.SetBreakpointResponse]]: - r"""Return a callable for the set breakpoint method over gRPC. - - Sets the breakpoint to the debuggee. - - Returns: - Callable[[~.SetBreakpointRequest], - Awaitable[~.SetBreakpointResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'set_breakpoint' not in self._stubs: - self._stubs['set_breakpoint'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Debugger2/SetBreakpoint', - request_serializer=debugger.SetBreakpointRequest.serialize, - response_deserializer=debugger.SetBreakpointResponse.deserialize, - ) - return self._stubs['set_breakpoint'] - - @property - def get_breakpoint(self) -> Callable[ - [debugger.GetBreakpointRequest], - Awaitable[debugger.GetBreakpointResponse]]: - r"""Return a callable for the get breakpoint method over gRPC. - - Gets breakpoint information. - - Returns: - Callable[[~.GetBreakpointRequest], - Awaitable[~.GetBreakpointResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'get_breakpoint' not in self._stubs: - self._stubs['get_breakpoint'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Debugger2/GetBreakpoint', - request_serializer=debugger.GetBreakpointRequest.serialize, - response_deserializer=debugger.GetBreakpointResponse.deserialize, - ) - return self._stubs['get_breakpoint'] - - @property - def delete_breakpoint(self) -> Callable[ - [debugger.DeleteBreakpointRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete breakpoint method over gRPC. - - Deletes the breakpoint from the debuggee. - - Returns: - Callable[[~.DeleteBreakpointRequest], - Awaitable[~.Empty]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'delete_breakpoint' not in self._stubs: - self._stubs['delete_breakpoint'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Debugger2/DeleteBreakpoint', - request_serializer=debugger.DeleteBreakpointRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_breakpoint'] - - @property - def list_breakpoints(self) -> Callable[ - [debugger.ListBreakpointsRequest], - Awaitable[debugger.ListBreakpointsResponse]]: - r"""Return a callable for the list breakpoints method over gRPC. - - Lists all breakpoints for the debuggee. - - Returns: - Callable[[~.ListBreakpointsRequest], - Awaitable[~.ListBreakpointsResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_breakpoints' not in self._stubs: - self._stubs['list_breakpoints'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Debugger2/ListBreakpoints', - request_serializer=debugger.ListBreakpointsRequest.serialize, - response_deserializer=debugger.ListBreakpointsResponse.deserialize, - ) - return self._stubs['list_breakpoints'] - - @property - def list_debuggees(self) -> Callable[ - [debugger.ListDebuggeesRequest], - Awaitable[debugger.ListDebuggeesResponse]]: - r"""Return a callable for the list debuggees method over gRPC. - - Lists all the debuggees that the user has access to. - - Returns: - Callable[[~.ListDebuggeesRequest], - Awaitable[~.ListDebuggeesResponse]]: - A function that, when called, will call the underlying RPC - on the server. - """ - # Generate a "stub function" on-the-fly which will actually make - # the request. - # gRPC handles serialization and deserialization, so we just need - # to pass in the functions for each. - if 'list_debuggees' not in self._stubs: - self._stubs['list_debuggees'] = self.grpc_channel.unary_unary( - '/google.devtools.clouddebugger.v2.Debugger2/ListDebuggees', - request_serializer=debugger.ListDebuggeesRequest.serialize, - response_deserializer=debugger.ListDebuggeesResponse.deserialize, - ) - return self._stubs['list_debuggees'] - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'Debugger2GrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py b/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py deleted file mode 100644 index 047c89e..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py +++ /dev/null @@ -1,68 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -from .controller import ( - ListActiveBreakpointsRequest, - ListActiveBreakpointsResponse, - RegisterDebuggeeRequest, - RegisterDebuggeeResponse, - UpdateActiveBreakpointRequest, - UpdateActiveBreakpointResponse, -) -from .data import ( - Breakpoint, - Debuggee, - FormatMessage, - SourceLocation, - StackFrame, - StatusMessage, - Variable, -) -from .debugger import ( - DeleteBreakpointRequest, - GetBreakpointRequest, - GetBreakpointResponse, - ListBreakpointsRequest, - ListBreakpointsResponse, - ListDebuggeesRequest, - ListDebuggeesResponse, - SetBreakpointRequest, - SetBreakpointResponse, -) - -__all__ = ( - 'ListActiveBreakpointsRequest', - 'ListActiveBreakpointsResponse', - 'RegisterDebuggeeRequest', - 'RegisterDebuggeeResponse', - 'UpdateActiveBreakpointRequest', - 'UpdateActiveBreakpointResponse', - 'Breakpoint', - 'Debuggee', - 'FormatMessage', - 'SourceLocation', - 'StackFrame', - 'StatusMessage', - 'Variable', - 'DeleteBreakpointRequest', - 'GetBreakpointRequest', - 'GetBreakpointResponse', - 'ListBreakpointsRequest', - 'ListBreakpointsResponse', - 'ListDebuggeesRequest', - 'ListDebuggeesResponse', - 'SetBreakpointRequest', - 'SetBreakpointResponse', -) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py b/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py deleted file mode 100644 index 7eea2a6..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py +++ /dev/null @@ -1,172 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import proto # type: ignore - -from google.cloud.debugger_v2.types import data - - -__protobuf__ = proto.module( - package='google.devtools.clouddebugger.v2', - manifest={ - 'RegisterDebuggeeRequest', - 'RegisterDebuggeeResponse', - 'ListActiveBreakpointsRequest', - 'ListActiveBreakpointsResponse', - 'UpdateActiveBreakpointRequest', - 'UpdateActiveBreakpointResponse', - }, -) - - -class RegisterDebuggeeRequest(proto.Message): - r"""Request to register a debuggee. - - Attributes: - debuggee (google.cloud.debugger_v2.types.Debuggee): - Required. Debuggee information to register. The fields - ``project``, ``uniquifier``, ``description`` and - ``agent_version`` of the debuggee must be set. - """ - - debuggee = proto.Field( - proto.MESSAGE, - number=1, - message=data.Debuggee, - ) - - -class RegisterDebuggeeResponse(proto.Message): - r"""Response for registering a debuggee. - - Attributes: - debuggee (google.cloud.debugger_v2.types.Debuggee): - Debuggee resource. The field ``id`` is guaranteed to be set - (in addition to the echoed fields). If the field - ``is_disabled`` is set to ``true``, the agent should disable - itself by removing all breakpoints and detaching from the - application. It should however continue to poll - ``RegisterDebuggee`` until reenabled. - """ - - debuggee = proto.Field( - proto.MESSAGE, - number=1, - message=data.Debuggee, - ) - - -class ListActiveBreakpointsRequest(proto.Message): - r"""Request to list active breakpoints. - - Attributes: - debuggee_id (str): - Required. Identifies the debuggee. - wait_token (str): - A token that, if specified, blocks the method call until the - list of active breakpoints has changed, or a server-selected - timeout has expired. The value should be set from the - ``next_wait_token`` field in the last response. The initial - value should be set to ``"init"``. - success_on_timeout (bool): - If set to ``true`` (recommended), returns - ``google.rpc.Code.OK`` status and sets the ``wait_expired`` - response field to ``true`` when the server-selected timeout - has expired. - - If set to ``false`` (deprecated), returns - ``google.rpc.Code.ABORTED`` status when the server-selected - timeout has expired. - """ - - debuggee_id = proto.Field( - proto.STRING, - number=1, - ) - wait_token = proto.Field( - proto.STRING, - number=2, - ) - success_on_timeout = proto.Field( - proto.BOOL, - number=3, - ) - - -class ListActiveBreakpointsResponse(proto.Message): - r"""Response for listing active breakpoints. - - Attributes: - breakpoints (Sequence[google.cloud.debugger_v2.types.Breakpoint]): - List of all active breakpoints. The fields ``id`` and - ``location`` are guaranteed to be set on each breakpoint. - next_wait_token (str): - A token that can be used in the next method - call to block until the list of breakpoints - changes. - wait_expired (bool): - If set to ``true``, indicates that there is no change to the - list of active breakpoints and the server-selected timeout - has expired. The ``breakpoints`` field would be empty and - should be ignored. - """ - - breakpoints = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - next_wait_token = proto.Field( - proto.STRING, - number=2, - ) - wait_expired = proto.Field( - proto.BOOL, - number=3, - ) - - -class UpdateActiveBreakpointRequest(proto.Message): - r"""Request to update an active breakpoint. - - Attributes: - debuggee_id (str): - Required. Identifies the debuggee being - debugged. - breakpoint_ (google.cloud.debugger_v2.types.Breakpoint): - Required. Updated breakpoint information. The field ``id`` - must be set. The agent must echo all Breakpoint - specification fields in the update. - """ - - debuggee_id = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_ = proto.Field( - proto.MESSAGE, - number=2, - message=data.Breakpoint, - ) - - -class UpdateActiveBreakpointResponse(proto.Message): - r"""Response for updating an active breakpoint. - The message is defined to allow future extensions. - - """ - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py b/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py deleted file mode 100644 index f743b48..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py +++ /dev/null @@ -1,636 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import proto # type: ignore - -from google.devtools.source.v1 import source_context_pb2 # type: ignore -from google.protobuf import timestamp_pb2 # type: ignore -from google.protobuf import wrappers_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.devtools.clouddebugger.v2', - manifest={ - 'FormatMessage', - 'StatusMessage', - 'SourceLocation', - 'Variable', - 'StackFrame', - 'Breakpoint', - 'Debuggee', - }, -) - - -class FormatMessage(proto.Message): - r"""Represents a message with parameters. - - Attributes: - format_ (str): - Format template for the message. The ``format`` uses - placeholders ``$0``, ``$1``, etc. to reference parameters. - ``$$`` can be used to denote the ``$`` character. - - Examples: - - - ``Failed to load '$0' which helps debug $1 the first time it is loaded. Again, $0 is very important.`` - - ``Please pay $$10 to use $0 instead of $1.`` - parameters (Sequence[str]): - Optional parameters to be embedded into the - message. - """ - - format_ = proto.Field( - proto.STRING, - number=1, - ) - parameters = proto.RepeatedField( - proto.STRING, - number=2, - ) - - -class StatusMessage(proto.Message): - r"""Represents a contextual status message. The message can indicate an - error or informational status, and refer to specific parts of the - containing object. For example, the ``Breakpoint.status`` field can - indicate an error referring to the ``BREAKPOINT_SOURCE_LOCATION`` - with the message ``Location not found``. - - Attributes: - is_error (bool): - Distinguishes errors from informational - messages. - refers_to (google.cloud.debugger_v2.types.StatusMessage.Reference): - Reference to which the message applies. - description (google.cloud.debugger_v2.types.FormatMessage): - Status message text. - """ - class Reference(proto.Enum): - r"""Enumerates references to which the message applies.""" - UNSPECIFIED = 0 - BREAKPOINT_SOURCE_LOCATION = 3 - BREAKPOINT_CONDITION = 4 - BREAKPOINT_EXPRESSION = 7 - BREAKPOINT_AGE = 8 - VARIABLE_NAME = 5 - VARIABLE_VALUE = 6 - - is_error = proto.Field( - proto.BOOL, - number=1, - ) - refers_to = proto.Field( - proto.ENUM, - number=2, - enum=Reference, - ) - description = proto.Field( - proto.MESSAGE, - number=3, - message='FormatMessage', - ) - - -class SourceLocation(proto.Message): - r"""Represents a location in the source code. - - Attributes: - path (str): - Path to the source file within the source - context of the target binary. - line (int): - Line inside the file. The first line in the file has the - value ``1``. - column (int): - Column within a line. The first column in a line as the - value ``1``. Agents that do not support setting breakpoints - on specific columns ignore this field. - """ - - path = proto.Field( - proto.STRING, - number=1, - ) - line = proto.Field( - proto.INT32, - number=2, - ) - column = proto.Field( - proto.INT32, - number=3, - ) - - -class Variable(proto.Message): - r"""Represents a variable or an argument possibly of a compound object - type. Note how the following variables are represented: - - 1) A simple variable: - - int x = 5 - - { name: "x", value: "5", type: "int" } // Captured variable - - 2) A compound object: - - struct T { int m1; int m2; }; T x = { 3, 7 }; - - { // Captured variable name: "x", type: "T", members { name: - "m1", value: "3", type: "int" }, members { name: "m2", value: - "7", type: "int" } } - - 3) A pointer where the pointee was captured: - - T x = { 3, 7 }; T\* p = &x; - - { // Captured variable name: "p", type: "T*", value: - "0x00500500", members { name: "m1", value: "3", type: "int" }, - members { name: "m2", value: "7", type: "int" } } - - 4) A pointer where the pointee was not captured: - - T\* p = new T; - - { // Captured variable name: "p", type: "T*", value: "0x00400400" - status { is_error: true, description { format: "unavailable" } } - } - - The status should describe the reason for the missing value, such as - ````, ````, - ````. - - Note that a null pointer should not have members. - - 5) An unnamed value: - - int\* p = new int(7); - - { // Captured variable name: "p", value: "0x00500500", type: - "int*", members { value: "7", type: "int" } } - - 6) An unnamed pointer where the pointee was not captured: - - int\* p = new int(7); int*\* pp = &p; - - { // Captured variable name: "pp", value: "0x00500500", type: - "int**", members { value: "0x00400400", type: "int*" status { - is_error: true, description: { format: "unavailable" } } } } } - - To optimize computation, memory and network traffic, variables that - repeat in the output multiple times can be stored once in a shared - variable table and be referenced using the ``var_table_index`` - field. The variables stored in the shared table are nameless and are - essentially a partition of the complete variable. To reconstruct the - complete variable, merge the referencing variable with the - referenced variable. - - When using the shared variable table, the following variables: - - :: - - T x = { 3, 7 }; - T* p = &x; - T& r = x; - - { name: "x", var_table_index: 3, type: "T" } // Captured variables - { name: "p", value "0x00500500", type="T*", var_table_index: 3 } - { name: "r", type="T&", var_table_index: 3 } - - { // Shared variable table entry #3: - members { name: "m1", value: "3", type: "int" }, - members { name: "m2", value: "7", type: "int" } - } - - Note that the pointer address is stored with the referencing - variable and not with the referenced variable. This allows the - referenced variable to be shared between pointers and references. - - The type field is optional. The debugger agent may or may not - support it. - - Attributes: - name (str): - Name of the variable, if any. - value (str): - Simple value of the variable. - type_ (str): - Variable type (e.g. ``MyClass``). If the variable is split - with ``var_table_index``, ``type`` goes next to ``value``. - The interpretation of a type is agent specific. It is - recommended to include the dynamic type rather than a static - type of an object. - members (Sequence[google.cloud.debugger_v2.types.Variable]): - Members contained or pointed to by the - variable. - var_table_index (google.protobuf.wrappers_pb2.Int32Value): - Reference to a variable in the shared variable table. More - than one variable can reference the same variable in the - table. The ``var_table_index`` field is an index into - ``variable_table`` in Breakpoint. - status (google.cloud.debugger_v2.types.StatusMessage): - Status associated with the variable. This field will usually - stay unset. A status of a single variable only applies to - that variable or expression. The rest of breakpoint data - still remains valid. Variables might be reported in error - state even when breakpoint is not in final state. - - The message may refer to variable name with ``refers_to`` - set to ``VARIABLE_NAME``. Alternatively ``refers_to`` will - be set to ``VARIABLE_VALUE``. In either case variable value - and members will be unset. - - Example of error message applied to name: - ``Invalid expression syntax``. - - Example of information message applied to value: - ``Not captured``. - - Examples of error message applied to value: - - - ``Malformed string``, - - ``Field f not found in class C`` - - ``Null pointer dereference`` - """ - - name = proto.Field( - proto.STRING, - number=1, - ) - value = proto.Field( - proto.STRING, - number=2, - ) - type_ = proto.Field( - proto.STRING, - number=6, - ) - members = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Variable', - ) - var_table_index = proto.Field( - proto.MESSAGE, - number=4, - message=wrappers_pb2.Int32Value, - ) - status = proto.Field( - proto.MESSAGE, - number=5, - message='StatusMessage', - ) - - -class StackFrame(proto.Message): - r"""Represents a stack frame context. - - Attributes: - function (str): - Demangled function name at the call site. - location (google.cloud.debugger_v2.types.SourceLocation): - Source location of the call site. - arguments (Sequence[google.cloud.debugger_v2.types.Variable]): - Set of arguments passed to this function. - Note that this might not be populated for all - stack frames. - locals_ (Sequence[google.cloud.debugger_v2.types.Variable]): - Set of local variables at the stack frame - location. Note that this might not be populated - for all stack frames. - """ - - function = proto.Field( - proto.STRING, - number=1, - ) - location = proto.Field( - proto.MESSAGE, - number=2, - message='SourceLocation', - ) - arguments = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Variable', - ) - locals_ = proto.RepeatedField( - proto.MESSAGE, - number=4, - message='Variable', - ) - - -class Breakpoint(proto.Message): - r"""Represents the breakpoint specification, status and results. - - Attributes: - id (str): - Breakpoint identifier, unique in the scope of - the debuggee. - action (google.cloud.debugger_v2.types.Breakpoint.Action): - Action that the agent should perform when the - code at the breakpoint location is hit. - location (google.cloud.debugger_v2.types.SourceLocation): - Breakpoint source location. - condition (str): - Condition that triggers the breakpoint. - The condition is a compound boolean expression - composed using expressions in a programming - language at the source location. - expressions (Sequence[str]): - List of read-only expressions to evaluate at the breakpoint - location. The expressions are composed using expressions in - the programming language at the source location. If the - breakpoint action is ``LOG``, the evaluated expressions are - included in log statements. - log_message_format (str): - Only relevant when action is ``LOG``. Defines the message to - log when the breakpoint hits. The message may include - parameter placeholders ``$0``, ``$1``, etc. These - placeholders are replaced with the evaluated value of the - appropriate expression. Expressions not referenced in - ``log_message_format`` are not logged. - - Example: ``Message received, id = $0, count = $1`` with - ``expressions`` = ``[ message.id, message.count ]``. - log_level (google.cloud.debugger_v2.types.Breakpoint.LogLevel): - Indicates the severity of the log. Only relevant when action - is ``LOG``. - is_final_state (bool): - When true, indicates that this is a final - result and the breakpoint state will not change - from here on. - create_time (google.protobuf.timestamp_pb2.Timestamp): - Time this breakpoint was created by the - server in seconds resolution. - final_time (google.protobuf.timestamp_pb2.Timestamp): - Time this breakpoint was finalized as seen by - the server in seconds resolution. - user_email (str): - E-mail address of the user that created this - breakpoint - status (google.cloud.debugger_v2.types.StatusMessage): - Breakpoint status. - - The status includes an error flag and a human readable - message. This field is usually unset. The message can be - either informational or an error message. Regardless, - clients should always display the text message back to the - user. - - Error status indicates complete failure of the breakpoint. - - Example (non-final state): ``Still loading symbols...`` - - Examples (final state): - - - ``Invalid line number`` referring to location - - ``Field f not found in class C`` referring to condition - stack_frames (Sequence[google.cloud.debugger_v2.types.StackFrame]): - The stack at breakpoint time, where stack_frames[0] - represents the most recently entered function. - evaluated_expressions (Sequence[google.cloud.debugger_v2.types.Variable]): - Values of evaluated expressions at breakpoint time. The - evaluated expressions appear in exactly the same order they - are listed in the ``expressions`` field. The ``name`` field - holds the original expression text, the ``value`` or - ``members`` field holds the result of the evaluated - expression. If the expression cannot be evaluated, the - ``status`` inside the ``Variable`` will indicate an error - and contain the error text. - variable_table (Sequence[google.cloud.debugger_v2.types.Variable]): - The ``variable_table`` exists to aid with computation, - memory and network traffic optimization. It enables storing - a variable once and reference it from multiple variables, - including variables stored in the ``variable_table`` itself. - For example, the same ``this`` object, which may appear at - many levels of the stack, can have all of its data stored - once in this table. The stack frame variables then would - hold only a reference to it. - - The variable ``var_table_index`` field is an index into this - repeated field. The stored objects are nameless and get - their name from the referencing variable. The effective - variable is a merge of the referencing variable and the - referenced variable. - labels (Sequence[google.cloud.debugger_v2.types.Breakpoint.LabelsEntry]): - A set of custom breakpoint properties, - populated by the agent, to be displayed to the - user. - """ - class Action(proto.Enum): - r"""Actions that can be taken when a breakpoint hits. - Agents should reject breakpoints with unsupported or unknown - action values. - """ - CAPTURE = 0 - LOG = 1 - - class LogLevel(proto.Enum): - r"""Log severity levels.""" - INFO = 0 - WARNING = 1 - ERROR = 2 - - id = proto.Field( - proto.STRING, - number=1, - ) - action = proto.Field( - proto.ENUM, - number=13, - enum=Action, - ) - location = proto.Field( - proto.MESSAGE, - number=2, - message='SourceLocation', - ) - condition = proto.Field( - proto.STRING, - number=3, - ) - expressions = proto.RepeatedField( - proto.STRING, - number=4, - ) - log_message_format = proto.Field( - proto.STRING, - number=14, - ) - log_level = proto.Field( - proto.ENUM, - number=15, - enum=LogLevel, - ) - is_final_state = proto.Field( - proto.BOOL, - number=5, - ) - create_time = proto.Field( - proto.MESSAGE, - number=11, - message=timestamp_pb2.Timestamp, - ) - final_time = proto.Field( - proto.MESSAGE, - number=12, - message=timestamp_pb2.Timestamp, - ) - user_email = proto.Field( - proto.STRING, - number=16, - ) - status = proto.Field( - proto.MESSAGE, - number=10, - message='StatusMessage', - ) - stack_frames = proto.RepeatedField( - proto.MESSAGE, - number=7, - message='StackFrame', - ) - evaluated_expressions = proto.RepeatedField( - proto.MESSAGE, - number=8, - message='Variable', - ) - variable_table = proto.RepeatedField( - proto.MESSAGE, - number=9, - message='Variable', - ) - labels = proto.MapField( - proto.STRING, - proto.STRING, - number=17, - ) - - -class Debuggee(proto.Message): - r"""Represents the debugged application. The application may - include one or more replicated processes executing the same - code. Each of these processes is attached with a debugger agent, - carrying out the debugging commands. Agents attached to the same - debuggee identify themselves as such by using exactly the same - Debuggee message value when registering. - - Attributes: - id (str): - Unique identifier for the debuggee generated - by the controller service. - project (str): - Project the debuggee is associated with. - Use project number or id when registering a - Google Cloud Platform project. - uniquifier (str): - Uniquifier to further distinguish the - application. It is possible that different - applications might have identical values in the - debuggee message, thus, incorrectly identified - as a single application by the Controller - service. This field adds salt to further - distinguish the application. Agents should - consider seeding this field with value that - identifies the code, binary, configuration and - environment. - description (str): - Human readable description of the debuggee. - Including a human-readable project name, - environment name and version information is - recommended. - is_inactive (bool): - If set to ``true``, indicates that Controller service does - not detect any activity from the debuggee agents and the - application is possibly stopped. - agent_version (str): - Version ID of the agent. Schema: - ``domain/language-platform/vmajor.minor`` (for example - ``google.com/java-gcp/v1.1``). - is_disabled (bool): - If set to ``true``, indicates that the agent should disable - itself and detach from the debuggee. - status (google.cloud.debugger_v2.types.StatusMessage): - Human readable message to be displayed to the - user about this debuggee. Absence of this field - indicates no status. The message can be either - informational or an error status. - source_contexts (Sequence[google.devtools.source.v1.source_context_pb2.SourceContext]): - References to the locations and revisions of - the source code used in the deployed - application. - ext_source_contexts (Sequence[google.devtools.source.v1.source_context_pb2.ExtendedSourceContext]): - References to the locations and revisions of - the source code used in the deployed - application. - labels (Sequence[google.cloud.debugger_v2.types.Debuggee.LabelsEntry]): - A set of custom debuggee properties, - populated by the agent, to be displayed to the - user. - """ - - id = proto.Field( - proto.STRING, - number=1, - ) - project = proto.Field( - proto.STRING, - number=2, - ) - uniquifier = proto.Field( - proto.STRING, - number=3, - ) - description = proto.Field( - proto.STRING, - number=4, - ) - is_inactive = proto.Field( - proto.BOOL, - number=5, - ) - agent_version = proto.Field( - proto.STRING, - number=6, - ) - is_disabled = proto.Field( - proto.BOOL, - number=7, - ) - status = proto.Field( - proto.MESSAGE, - number=8, - message='StatusMessage', - ) - source_contexts = proto.RepeatedField( - proto.MESSAGE, - number=9, - message=source_context_pb2.SourceContext, - ) - ext_source_contexts = proto.RepeatedField( - proto.MESSAGE, - number=13, - message=source_context_pb2.ExtendedSourceContext, - ) - labels = proto.MapField( - proto.STRING, - proto.STRING, - number=11, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py b/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py deleted file mode 100644 index 47fea00..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py +++ /dev/null @@ -1,311 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import proto # type: ignore - -from google.cloud.debugger_v2.types import data - - -__protobuf__ = proto.module( - package='google.devtools.clouddebugger.v2', - manifest={ - 'SetBreakpointRequest', - 'SetBreakpointResponse', - 'GetBreakpointRequest', - 'GetBreakpointResponse', - 'DeleteBreakpointRequest', - 'ListBreakpointsRequest', - 'ListBreakpointsResponse', - 'ListDebuggeesRequest', - 'ListDebuggeesResponse', - }, -) - - -class SetBreakpointRequest(proto.Message): - r"""Request to set a breakpoint - - Attributes: - debuggee_id (str): - Required. ID of the debuggee where the - breakpoint is to be set. - breakpoint_ (google.cloud.debugger_v2.types.Breakpoint): - Required. Breakpoint specification to set. The field - ``location`` of the breakpoint must be set. - client_version (str): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., ``google.com/intellij/v1``). - """ - - debuggee_id = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_ = proto.Field( - proto.MESSAGE, - number=2, - message=data.Breakpoint, - ) - client_version = proto.Field( - proto.STRING, - number=4, - ) - - -class SetBreakpointResponse(proto.Message): - r"""Response for setting a breakpoint. - - Attributes: - breakpoint_ (google.cloud.debugger_v2.types.Breakpoint): - Breakpoint resource. The field ``id`` is guaranteed to be - set (in addition to the echoed fileds). - """ - - breakpoint_ = proto.Field( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - - -class GetBreakpointRequest(proto.Message): - r"""Request to get breakpoint information. - - Attributes: - debuggee_id (str): - Required. ID of the debuggee whose breakpoint - to get. - breakpoint_id (str): - Required. ID of the breakpoint to get. - client_version (str): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., ``google.com/intellij/v1``). - """ - - debuggee_id = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_id = proto.Field( - proto.STRING, - number=2, - ) - client_version = proto.Field( - proto.STRING, - number=4, - ) - - -class GetBreakpointResponse(proto.Message): - r"""Response for getting breakpoint information. - - Attributes: - breakpoint_ (google.cloud.debugger_v2.types.Breakpoint): - Complete breakpoint state. The fields ``id`` and - ``location`` are guaranteed to be set. - """ - - breakpoint_ = proto.Field( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - - -class DeleteBreakpointRequest(proto.Message): - r"""Request to delete a breakpoint. - - Attributes: - debuggee_id (str): - Required. ID of the debuggee whose breakpoint - to delete. - breakpoint_id (str): - Required. ID of the breakpoint to delete. - client_version (str): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., ``google.com/intellij/v1``). - """ - - debuggee_id = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_id = proto.Field( - proto.STRING, - number=2, - ) - client_version = proto.Field( - proto.STRING, - number=3, - ) - - -class ListBreakpointsRequest(proto.Message): - r"""Request to list breakpoints. - - Attributes: - debuggee_id (str): - Required. ID of the debuggee whose - breakpoints to list. - include_all_users (bool): - When set to ``true``, the response includes the list of - breakpoints set by any user. Otherwise, it includes only - breakpoints set by the caller. - include_inactive (bool): - When set to ``true``, the response includes active and - inactive breakpoints. Otherwise, it includes only active - breakpoints. - action (google.cloud.debugger_v2.types.ListBreakpointsRequest.BreakpointActionValue): - When set, the response includes only - breakpoints with the specified action. - strip_results (bool): - This field is deprecated. The following fields are always - stripped out of the result: ``stack_frames``, - ``evaluated_expressions`` and ``variable_table``. - wait_token (str): - A wait token that, if specified, blocks the call until the - breakpoints list has changed, or a server selected timeout - has expired. The value should be set from the last response. - The error code ``google.rpc.Code.ABORTED`` (RPC) is returned - on wait timeout, which should be called again with the same - ``wait_token``. - client_version (str): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., ``google.com/intellij/v1``). - """ - - class BreakpointActionValue(proto.Message): - r"""Wrapper message for ``Breakpoint.Action``. Defines a filter on the - action field of breakpoints. - - Attributes: - value (google.cloud.debugger_v2.types.Breakpoint.Action): - Only breakpoints with the specified action - will pass the filter. - """ - - value = proto.Field( - proto.ENUM, - number=1, - enum=data.Breakpoint.Action, - ) - - debuggee_id = proto.Field( - proto.STRING, - number=1, - ) - include_all_users = proto.Field( - proto.BOOL, - number=2, - ) - include_inactive = proto.Field( - proto.BOOL, - number=3, - ) - action = proto.Field( - proto.MESSAGE, - number=4, - message=BreakpointActionValue, - ) - strip_results = proto.Field( - proto.BOOL, - number=5, - ) - wait_token = proto.Field( - proto.STRING, - number=6, - ) - client_version = proto.Field( - proto.STRING, - number=8, - ) - - -class ListBreakpointsResponse(proto.Message): - r"""Response for listing breakpoints. - - Attributes: - breakpoints (Sequence[google.cloud.debugger_v2.types.Breakpoint]): - List of breakpoints matching the request. The fields ``id`` - and ``location`` are guaranteed to be set on each - breakpoint. The fields: ``stack_frames``, - ``evaluated_expressions`` and ``variable_table`` are cleared - on each breakpoint regardless of its status. - next_wait_token (str): - A wait token that can be used in the next call to ``list`` - (REST) or ``ListBreakpoints`` (RPC) to block until the list - of breakpoints has changes. - """ - - breakpoints = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - next_wait_token = proto.Field( - proto.STRING, - number=2, - ) - - -class ListDebuggeesRequest(proto.Message): - r"""Request to list debuggees. - - Attributes: - project (str): - Required. Project number of a Google Cloud - project whose debuggees to list. - include_inactive (bool): - When set to ``true``, the result includes all debuggees. - Otherwise, the result includes only debuggees that are - active. - client_version (str): - Required. The client version making the call. Schema: - ``domain/type/version`` (e.g., ``google.com/intellij/v1``). - """ - - project = proto.Field( - proto.STRING, - number=2, - ) - include_inactive = proto.Field( - proto.BOOL, - number=3, - ) - client_version = proto.Field( - proto.STRING, - number=4, - ) - - -class ListDebuggeesResponse(proto.Message): - r"""Response for listing debuggees. - - Attributes: - debuggees (Sequence[google.cloud.debugger_v2.types.Debuggee]): - List of debuggees accessible to the calling user. The fields - ``debuggee.id`` and ``description`` are guaranteed to be - set. The ``description`` field is a human readable field - provided by agents and can be displayed to users. - """ - - debuggees = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Debuggee, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v2/mypy.ini b/owl-bot-staging/v2/mypy.ini deleted file mode 100644 index 4505b48..0000000 --- a/owl-bot-staging/v2/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.6 -namespace_packages = True diff --git a/owl-bot-staging/v2/noxfile.py b/owl-bot-staging/v2/noxfile.py deleted file mode 100644 index 0a0ac5a..0000000 --- a/owl-bot-staging/v2/noxfile.py +++ /dev/null @@ -1,132 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import os -import pathlib -import shutil -import subprocess -import sys - - -import nox # type: ignore - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = subprocess.check_output([sys.executable, "setup.py", "--name"], encoding="utf-8") - - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", -] - -@nox.session(python=['3.6', '3.7', '3.8', '3.9', '3.10']) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/debugger_v2/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python='3.9') -def cover(session): - """Run the final coverage report. - This outputs the coverage report aggregating coverage from the unit - test runs (not system test runs), and then erases coverage data. - """ - session.install("coverage", "pytest-cov") - session.run("coverage", "report", "--show-missing", "--fail-under=100") - - session.run("coverage", "erase") - - -@nox.session(python=['3.6', '3.7', '3.8', '3.9']) -def mypy(session): - """Run the type checker.""" - session.install('mypy', 'types-pkg_resources') - session.install('.') - session.run( - 'mypy', - '--explicit-package-bases', - 'google', - ) - - -@nox.session -def update_lower_bounds(session): - """Update lower bounds in constraints.txt to match setup.py""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'update', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - - -@nox.session -def check_lower_bounds(session): - """Check lower bounds in setup.py are reflected in constraints file""" - session.install('google-cloud-testutils') - session.install('.') - - session.run( - 'lower-bound-checker', - 'check', - '--package-name', - PACKAGE_NAME, - '--constraints-file', - str(LOWER_BOUND_CONSTRAINTS_FILE), - ) - -@nox.session(python='3.9') -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx==4.0.1", "alabaster", "recommonmark") - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) diff --git a/owl-bot-staging/v2/scripts/fixup_debugger_v2_keywords.py b/owl-bot-staging/v2/scripts/fixup_debugger_v2_keywords.py deleted file mode 100644 index 0f21424..0000000 --- a/owl-bot-staging/v2/scripts/fixup_debugger_v2_keywords.py +++ /dev/null @@ -1,183 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import argparse -import os -import libcst as cst -import pathlib -import sys -from typing import (Any, Callable, Dict, List, Sequence, Tuple) - - -def partition( - predicate: Callable[[Any], bool], - iterator: Sequence[Any] -) -> Tuple[List[Any], List[Any]]: - """A stable, out-of-place partition.""" - results = ([], []) - - for i in iterator: - results[int(predicate(i))].append(i) - - # Returns trueList, falseList - return results[1], results[0] - - -class debuggerCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'delete_breakpoint': ('debuggee_id', 'breakpoint_id', 'client_version', ), - 'get_breakpoint': ('debuggee_id', 'breakpoint_id', 'client_version', ), - 'list_active_breakpoints': ('debuggee_id', 'wait_token', 'success_on_timeout', ), - 'list_breakpoints': ('debuggee_id', 'client_version', 'include_all_users', 'include_inactive', 'action', 'strip_results', 'wait_token', ), - 'list_debuggees': ('project', 'client_version', 'include_inactive', ), - 'register_debuggee': ('debuggee', ), - 'set_breakpoint': ('debuggee_id', 'breakpoint_', 'client_version', ), - 'update_active_breakpoint': ('debuggee_id', 'breakpoint_', ), - } - - def leave_Call(self, original: cst.Call, updated: cst.Call) -> cst.CSTNode: - try: - key = original.func.attr.value - kword_params = self.METHOD_TO_PARAMS[key] - except (AttributeError, KeyError): - # Either not a method from the API or too convoluted to be sure. - return updated - - # If the existing code is valid, keyword args come after positional args. - # Therefore, all positional args must map to the first parameters. - args, kwargs = partition(lambda a: not bool(a.keyword), updated.args) - if any(k.keyword.value == "request" for k in kwargs): - # We've already fixed this file, don't fix it again. - return updated - - kwargs, ctrl_kwargs = partition( - lambda a: a.keyword.value not in self.CTRL_PARAMS, - kwargs - ) - - args, ctrl_args = args[:len(kword_params)], args[len(kword_params):] - ctrl_kwargs.extend(cst.Arg(value=a.value, keyword=cst.Name(value=ctrl)) - for a, ctrl in zip(ctrl_args, self.CTRL_PARAMS)) - - request_arg = cst.Arg( - value=cst.Dict([ - cst.DictElement( - cst.SimpleString("'{}'".format(name)), -cst.Element(value=arg.value) - ) - # Note: the args + kwargs looks silly, but keep in mind that - # the control parameters had to be stripped out, and that - # those could have been passed positionally or by keyword. - for name, arg in zip(kword_params, args + kwargs)]), - keyword=cst.Name("request") - ) - - return updated.with_changes( - args=[request_arg] + ctrl_kwargs - ) - - -def fix_files( - in_dir: pathlib.Path, - out_dir: pathlib.Path, - *, - transformer=debuggerCallTransformer(), -): - """Duplicate the input dir to the output dir, fixing file method calls. - - Preconditions: - * in_dir is a real directory - * out_dir is a real, empty directory - """ - pyfile_gen = ( - pathlib.Path(os.path.join(root, f)) - for root, _, files in os.walk(in_dir) - for f in files if os.path.splitext(f)[1] == ".py" - ) - - for fpath in pyfile_gen: - with open(fpath, 'r') as f: - src = f.read() - - # Parse the code and insert method call fixes. - tree = cst.parse_module(src) - updated = tree.visit(transformer) - - # Create the path and directory structure for the new file. - updated_path = out_dir.joinpath(fpath.relative_to(in_dir)) - updated_path.parent.mkdir(parents=True, exist_ok=True) - - # Generate the updated source file at the corresponding path. - with open(updated_path, 'w') as f: - f.write(updated.code) - - -if __name__ == '__main__': - parser = argparse.ArgumentParser( - description="""Fix up source that uses the debugger client library. - -The existing sources are NOT overwritten but are copied to output_dir with changes made. - -Note: This tool operates at a best-effort level at converting positional - parameters in client method calls to keyword based parameters. - Cases where it WILL FAIL include - A) * or ** expansion in a method call. - B) Calls via function or method alias (includes free function calls) - C) Indirect or dispatched calls (e.g. the method is looked up dynamically) - - These all constitute false negatives. The tool will also detect false - positives when an API method shares a name with another method. -""") - parser.add_argument( - '-d', - '--input-directory', - required=True, - dest='input_dir', - help='the input directory to walk for python files to fix up', - ) - parser.add_argument( - '-o', - '--output-directory', - required=True, - dest='output_dir', - help='the directory to output files fixed via un-flattening', - ) - args = parser.parse_args() - input_dir = pathlib.Path(args.input_dir) - output_dir = pathlib.Path(args.output_dir) - if not input_dir.is_dir(): - print( - f"input directory '{input_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if not output_dir.is_dir(): - print( - f"output directory '{output_dir}' does not exist or is not a directory", - file=sys.stderr, - ) - sys.exit(-1) - - if os.listdir(output_dir): - print( - f"output directory '{output_dir}' is not empty", - file=sys.stderr, - ) - sys.exit(-1) - - fix_files(input_dir, output_dir) diff --git a/owl-bot-staging/v2/setup.py b/owl-bot-staging/v2/setup.py deleted file mode 100644 index 862ef17..0000000 --- a/owl-bot-staging/v2/setup.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import io -import os -import setuptools # type: ignore - -version = '0.1.0' - -package_root = os.path.abspath(os.path.dirname(__file__)) - -readme_filename = os.path.join(package_root, 'README.rst') -with io.open(readme_filename, encoding='utf-8') as readme_file: - readme = readme_file.read() - -setuptools.setup( - name='google-cloud-debugger-client', - version=version, - long_description=readme, - packages=setuptools.PEP420PackageFinder.find(), - namespace_packages=('google', 'google.cloud'), - platforms='Posix; MacOS X; Windows', - include_package_data=True, - install_requires=( - 'google-api-core[grpc] >= 1.28.0, < 3.0.0dev', - 'libcst >= 0.2.5', - 'proto-plus >= 1.19.7', - ), - python_requires='>=3.6', - classifiers=[ - 'Development Status :: 3 - Alpha', - 'Intended Audience :: Developers', - 'Operating System :: OS Independent', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Programming Language :: Python :: 3.9', - 'Topic :: Internet', - 'Topic :: Software Development :: Libraries :: Python Modules', - ], - zip_safe=False, -) diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v2/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# diff --git a/owl-bot-staging/v2/tests/unit/__init__.py b/owl-bot-staging/v2/tests/unit/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v2/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# diff --git a/owl-bot-staging/v2/tests/unit/gapic/__init__.py b/owl-bot-staging/v2/tests/unit/gapic/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# diff --git a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py deleted file mode 100644 index b54a5fc..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# diff --git a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py deleted file mode 100644 index 711b7b7..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py +++ /dev/null @@ -1,1580 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import os -import mock - -import grpc -from grpc.experimental import aio -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule - - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.api_core import path_template -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.debugger_v2.services.controller2 import Controller2AsyncClient -from google.cloud.debugger_v2.services.controller2 import Controller2Client -from google.cloud.debugger_v2.services.controller2 import transports -from google.cloud.debugger_v2.types import controller -from google.cloud.debugger_v2.types import data -from google.devtools.source.v1 import source_context_pb2 # type: ignore -from google.oauth2 import service_account -from google.protobuf import timestamp_pb2 # type: ignore -from google.protobuf import wrappers_pb2 # type: ignore -import google.auth - - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert Controller2Client._get_default_mtls_endpoint(None) is None - assert Controller2Client._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert Controller2Client._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert Controller2Client._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert Controller2Client._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert Controller2Client._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - Controller2Client, - Controller2AsyncClient, -]) -def test_controller2_client_from_service_account_info(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'clouddebugger.googleapis.com:443' - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.Controller2GrpcTransport, "grpc"), - (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_controller2_client_service_account_always_use_jwt(transport_class, transport_name): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=True) - use_jwt.assert_called_once_with(True) - - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=False) - use_jwt.assert_not_called() - - -@pytest.mark.parametrize("client_class", [ - Controller2Client, - Controller2AsyncClient, -]) -def test_controller2_client_from_service_account_file(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'clouddebugger.googleapis.com:443' - - -def test_controller2_client_get_transport_class(): - transport = Controller2Client.get_transport_class() - available_transports = [ - transports.Controller2GrpcTransport, - ] - assert transport in available_transports - - transport = Controller2Client.get_transport_class("grpc") - assert transport == transports.Controller2GrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (Controller2Client, transports.Controller2GrpcTransport, "grpc"), - (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(Controller2Client, "DEFAULT_ENDPOINT", modify_default_endpoint(Controller2Client)) -@mock.patch.object(Controller2AsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(Controller2AsyncClient)) -def test_controller2_client_client_options(client_class, transport_class, transport_name): - # Check that if channel is provided we won't create a new one. - with mock.patch.object(Controller2Client, 'get_transport_class') as gtc: - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ) - client = client_class(transport=transport) - gtc.assert_not_called() - - # Check that if channel is provided via str we will create a new one. - with mock.patch.object(Controller2Client, 'get_transport_class') as gtc: - client = client_class(transport=transport_name) - gtc.assert_called() - - # Check the case api_endpoint is provided. - options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name, client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_MTLS_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError): - client = client_class(transport=transport_name) - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError): - client = client_class(transport=transport_name) - - # Check the case quota_project_id is provided - options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (Controller2Client, transports.Controller2GrpcTransport, "grpc", "true"), - (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", "true"), - (Controller2Client, transports.Controller2GrpcTransport, "grpc", "false"), - (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(Controller2Client, "DEFAULT_ENDPOINT", modify_default_endpoint(Controller2Client)) -@mock.patch.object(Controller2AsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(Controller2AsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_controller2_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): - # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default - # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. - - # Check the case client_cert_source is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client.DEFAULT_ENDPOINT - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client.DEFAULT_ENDPOINT - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -@pytest.mark.parametrize("client_class", [ - Controller2Client, Controller2AsyncClient -]) -@mock.patch.object(Controller2Client, "DEFAULT_ENDPOINT", modify_default_endpoint(Controller2Client)) -@mock.patch.object(Controller2AsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(Controller2AsyncClient)) -def test_controller2_client_get_mtls_endpoint_and_cert_source(client_class): - mock_client_cert_source = mock.Mock() - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source == mock_client_cert_source - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): - mock_client_cert_source = mock.Mock() - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source == mock_client_cert_source - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (Controller2Client, transports.Controller2GrpcTransport, "grpc"), - (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_controller2_client_client_options_scopes(client_class, transport_class, transport_name): - # Check the case scopes are provided. - options = client_options.ClientOptions( - scopes=["1", "2"], - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (Controller2Client, transports.Controller2GrpcTransport, "grpc", grpc_helpers), - (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_controller2_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - -def test_controller2_client_client_options_from_dict(): - with mock.patch('google.cloud.debugger_v2.services.controller2.transports.Controller2GrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = Controller2Client( - client_options={'api_endpoint': 'squid.clam.whelk'} - ) - grpc_transport.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (Controller2Client, transports.Controller2GrpcTransport, "grpc", grpc_helpers), - (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_controller2_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # test that the credentials from file are saved and used as the credentials. - with mock.patch.object( - google.auth, "load_credentials_from_file", autospec=True - ) as load_creds, mock.patch.object( - google.auth, "default", autospec=True - ) as adc, mock.patch.object( - grpc_helpers, "create_channel" - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - file_creds = ga_credentials.AnonymousCredentials() - load_creds.return_value = (file_creds, None) - adc.return_value = (creds, None) - client = client_class(client_options=options, transport=transport_name) - create_channel.assert_called_with( - "clouddebugger.googleapis.com:443", - credentials=file_creds, - credentials_file=None, - quota_project_id=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud_debugger', -), - scopes=None, - default_host="clouddebugger.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - controller.RegisterDebuggeeRequest, - dict, -]) -def test_register_debuggee(request_type, transport: str = 'grpc'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_debuggee), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = controller.RegisterDebuggeeResponse( - ) - response = client.register_debuggee(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == controller.RegisterDebuggeeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.RegisterDebuggeeResponse) - - -def test_register_debuggee_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_debuggee), - '__call__') as call: - client.register_debuggee() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == controller.RegisterDebuggeeRequest() - - -@pytest.mark.asyncio -async def test_register_debuggee_async(transport: str = 'grpc_asyncio', request_type=controller.RegisterDebuggeeRequest): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_debuggee), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(controller.RegisterDebuggeeResponse( - )) - response = await client.register_debuggee(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == controller.RegisterDebuggeeRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.RegisterDebuggeeResponse) - - -@pytest.mark.asyncio -async def test_register_debuggee_async_from_dict(): - await test_register_debuggee_async(request_type=dict) - - -def test_register_debuggee_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_debuggee), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = controller.RegisterDebuggeeResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.register_debuggee( - debuggee=data.Debuggee(id='id_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee - mock_val = data.Debuggee(id='id_value') - assert arg == mock_val - - -def test_register_debuggee_flattened_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.register_debuggee( - controller.RegisterDebuggeeRequest(), - debuggee=data.Debuggee(id='id_value'), - ) - - -@pytest.mark.asyncio -async def test_register_debuggee_flattened_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.register_debuggee), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = controller.RegisterDebuggeeResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.RegisterDebuggeeResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.register_debuggee( - debuggee=data.Debuggee(id='id_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee - mock_val = data.Debuggee(id='id_value') - assert arg == mock_val - - -@pytest.mark.asyncio -async def test_register_debuggee_flattened_error_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.register_debuggee( - controller.RegisterDebuggeeRequest(), - debuggee=data.Debuggee(id='id_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - controller.ListActiveBreakpointsRequest, - dict, -]) -def test_list_active_breakpoints(request_type, transport: str = 'grpc'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_active_breakpoints), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = controller.ListActiveBreakpointsResponse( - next_wait_token='next_wait_token_value', - wait_expired=True, - ) - response = client.list_active_breakpoints(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == controller.ListActiveBreakpointsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.ListActiveBreakpointsResponse) - assert response.next_wait_token == 'next_wait_token_value' - assert response.wait_expired is True - - -def test_list_active_breakpoints_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_active_breakpoints), - '__call__') as call: - client.list_active_breakpoints() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == controller.ListActiveBreakpointsRequest() - - -@pytest.mark.asyncio -async def test_list_active_breakpoints_async(transport: str = 'grpc_asyncio', request_type=controller.ListActiveBreakpointsRequest): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_active_breakpoints), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse( - next_wait_token='next_wait_token_value', - wait_expired=True, - )) - response = await client.list_active_breakpoints(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == controller.ListActiveBreakpointsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.ListActiveBreakpointsResponse) - assert response.next_wait_token == 'next_wait_token_value' - assert response.wait_expired is True - - -@pytest.mark.asyncio -async def test_list_active_breakpoints_async_from_dict(): - await test_list_active_breakpoints_async(request_type=dict) - - -def test_list_active_breakpoints_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_active_breakpoints), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = controller.ListActiveBreakpointsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_active_breakpoints( - debuggee_id='debuggee_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee_id - mock_val = 'debuggee_id_value' - assert arg == mock_val - - -def test_list_active_breakpoints_flattened_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.list_active_breakpoints( - controller.ListActiveBreakpointsRequest(), - debuggee_id='debuggee_id_value', - ) - - -@pytest.mark.asyncio -async def test_list_active_breakpoints_flattened_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_active_breakpoints), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = controller.ListActiveBreakpointsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_active_breakpoints( - debuggee_id='debuggee_id_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee_id - mock_val = 'debuggee_id_value' - assert arg == mock_val - - -@pytest.mark.asyncio -async def test_list_active_breakpoints_flattened_error_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_active_breakpoints( - controller.ListActiveBreakpointsRequest(), - debuggee_id='debuggee_id_value', - ) - - -@pytest.mark.parametrize("request_type", [ - controller.UpdateActiveBreakpointRequest, - dict, -]) -def test_update_active_breakpoint(request_type, transport: str = 'grpc'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_active_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = controller.UpdateActiveBreakpointResponse( - ) - response = client.update_active_breakpoint(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == controller.UpdateActiveBreakpointRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.UpdateActiveBreakpointResponse) - - -def test_update_active_breakpoint_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_active_breakpoint), - '__call__') as call: - client.update_active_breakpoint() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == controller.UpdateActiveBreakpointRequest() - - -@pytest.mark.asyncio -async def test_update_active_breakpoint_async(transport: str = 'grpc_asyncio', request_type=controller.UpdateActiveBreakpointRequest): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_active_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse( - )) - response = await client.update_active_breakpoint(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == controller.UpdateActiveBreakpointRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.UpdateActiveBreakpointResponse) - - -@pytest.mark.asyncio -async def test_update_active_breakpoint_async_from_dict(): - await test_update_active_breakpoint_async(request_type=dict) - - -def test_update_active_breakpoint_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_active_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = controller.UpdateActiveBreakpointResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_active_breakpoint( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee_id - mock_val = 'debuggee_id_value' - assert arg == mock_val - arg = args[0].breakpoint_ - mock_val = data.Breakpoint(id='id_value') - assert arg == mock_val - - -def test_update_active_breakpoint_flattened_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.update_active_breakpoint( - controller.UpdateActiveBreakpointRequest(), - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - ) - - -@pytest.mark.asyncio -async def test_update_active_breakpoint_flattened_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_active_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = controller.UpdateActiveBreakpointResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_active_breakpoint( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee_id - mock_val = 'debuggee_id_value' - assert arg == mock_val - arg = args[0].breakpoint_ - mock_val = data.Breakpoint(id='id_value') - assert arg == mock_val - - -@pytest.mark.asyncio -async def test_update_active_breakpoint_flattened_error_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.update_active_breakpoint( - controller.UpdateActiveBreakpointRequest(), - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.Controller2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.Controller2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = Controller2Client( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.Controller2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = Controller2Client( - client_options=options, - transport=transport, - ) - - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = Controller2Client( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.Controller2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = Controller2Client( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.Controller2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = Controller2Client(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.Controller2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.Controller2GrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.Controller2GrpcTransport, - transports.Controller2GrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.Controller2GrpcTransport, - ) - -def test_controller2_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.Controller2Transport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_controller2_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.debugger_v2.services.controller2.transports.Controller2Transport.__init__') as Transport: - Transport.return_value = None - transport = transports.Controller2Transport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'register_debuggee', - 'list_active_breakpoints', - 'update_active_breakpoint', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - -def test_controller2_base_transport_with_credentials_file(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.debugger_v2.services.controller2.transports.Controller2Transport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.Controller2Transport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud_debugger', -), - quota_project_id="octopus", - ) - - -def test_controller2_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. - with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.debugger_v2.services.controller2.transports.Controller2Transport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.Controller2Transport() - adc.assert_called_once() - - -def test_controller2_auth_adc(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - Controller2Client() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud_debugger', -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.Controller2GrpcTransport, - transports.Controller2GrpcAsyncIOTransport, - ], -) -def test_controller2_transport_auth_adc(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus", scopes=["1", "2"]) - adc.assert_called_once_with( - scopes=["1", "2"], - default_scopes=( 'https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud_debugger',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.Controller2GrpcTransport, grpc_helpers), - (transports.Controller2GrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_controller2_transport_create_channel(transport_class, grpc_helpers): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( - grpc_helpers, "create_channel", autospec=True - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - adc.return_value = (creds, None) - transport_class( - quota_project_id="octopus", - scopes=["1", "2"] - ) - - create_channel.assert_called_with( - "clouddebugger.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud_debugger', -), - scopes=["1", "2"], - default_host="clouddebugger.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.Controller2GrpcTransport, transports.Controller2GrpcAsyncIOTransport]) -def test_controller2_grpc_transport_client_cert_source_for_mtls( - transport_class -): - cred = ga_credentials.AnonymousCredentials() - - # Check ssl_channel_credentials is used if provided. - with mock.patch.object(transport_class, "create_channel") as mock_create_channel: - mock_ssl_channel_creds = mock.Mock() - transport_class( - host="squid.clam.whelk", - credentials=cred, - ssl_channel_credentials=mock_ssl_channel_creds - ) - mock_create_channel.assert_called_once_with( - "squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_channel_creds, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls - # is used. - with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): - with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: - transport_class( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - expected_cert, expected_key = client_cert_source_callback() - mock_ssl_cred.assert_called_once_with( - certificate_chain=expected_cert, - private_key=expected_key - ) - - -def test_controller2_host_no_port(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), - ) - assert client.transport._host == 'clouddebugger.googleapis.com:443' - - -def test_controller2_host_with_port(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), - ) - assert client.transport._host == 'clouddebugger.googleapis.com:8000' - -def test_controller2_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.Controller2GrpcTransport( - host="squid.clam.whelk", - channel=channel, - ) - assert transport.grpc_channel == channel - assert transport._host == "squid.clam.whelk:443" - assert transport._ssl_channel_credentials == None - - -def test_controller2_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.Controller2GrpcAsyncIOTransport( - host="squid.clam.whelk", - channel=channel, - ) - assert transport.grpc_channel == channel - assert transport._host == "squid.clam.whelk:443" - assert transport._ssl_channel_credentials == None - - -# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are -# removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.Controller2GrpcTransport, transports.Controller2GrpcAsyncIOTransport]) -def test_controller2_transport_channel_mtls_with_client_cert_source( - transport_class -): - with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_ssl_cred = mock.Mock() - grpc_ssl_channel_cred.return_value = mock_ssl_cred - - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - - cred = ga_credentials.AnonymousCredentials() - with pytest.warns(DeprecationWarning): - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (cred, None) - transport = transport_class( - host="squid.clam.whelk", - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=client_cert_source_callback, - ) - adc.assert_called_once() - - grpc_ssl_channel_cred.assert_called_once_with( - certificate_chain=b"cert bytes", private_key=b"key bytes" - ) - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - assert transport._ssl_channel_credentials == mock_ssl_cred - - -# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are -# removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.Controller2GrpcTransport, transports.Controller2GrpcAsyncIOTransport]) -def test_controller2_transport_channel_mtls_with_adc( - transport_class -): - mock_ssl_cred = mock.Mock() - with mock.patch.multiple( - "google.auth.transport.grpc.SslCredentials", - __init__=mock.Mock(return_value=None), - ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), - ): - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - mock_cred = mock.Mock() - - with pytest.warns(DeprecationWarning): - transport = transport_class( - host="squid.clam.whelk", - credentials=mock_cred, - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=None, - ) - - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=mock_cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - - -def test_common_billing_account_path(): - billing_account = "squid" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = Controller2Client.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "clam", - } - path = Controller2Client.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = Controller2Client.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "whelk" - expected = "folders/{folder}".format(folder=folder, ) - actual = Controller2Client.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "octopus", - } - path = Controller2Client.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = Controller2Client.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "oyster" - expected = "organizations/{organization}".format(organization=organization, ) - actual = Controller2Client.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "nudibranch", - } - path = Controller2Client.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = Controller2Client.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "cuttlefish" - expected = "projects/{project}".format(project=project, ) - actual = Controller2Client.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "mussel", - } - path = Controller2Client.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = Controller2Client.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "winkle" - location = "nautilus" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = Controller2Client.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "scallop", - "location": "abalone", - } - path = Controller2Client.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = Controller2Client.parse_common_location_path(path) - assert expected == actual - - -def test_client_with_default_client_info(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.Controller2Transport, '_prep_wrapped_messages') as prep: - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.Controller2Transport, '_prep_wrapped_messages') as prep: - transport_class = Controller2Client.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - -@pytest.mark.asyncio -async def test_transport_close_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc_asyncio", - ) - with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: - async with client: - close.assert_not_called() - close.assert_called_once() - -def test_transport_close(): - transports = { - "grpc": "_grpc_channel", - } - - for transport, close_name in transports.items(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: - with client: - close.assert_not_called() - close.assert_called_once() - -def test_client_ctx(): - transports = [ - 'grpc', - ] - for transport in transports: - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - # Test client calls underlying transport. - with mock.patch.object(type(client.transport), "close") as close: - close.assert_not_called() - with client: - pass - close.assert_called() - -@pytest.mark.parametrize("client_class,transport_class", [ - (Controller2Client, transports.Controller2GrpcTransport), - (Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport), -]) -def test_api_key_credentials(client_class, transport_class): - with mock.patch.object( - google.auth._default, "get_api_key_credentials", create=True - ) as get_api_key_credentials: - mock_cred = mock.Mock() - get_api_key_credentials.return_value = mock_cred - options = client_options.ClientOptions() - options.api_key = "api_key" - with mock.patch.object(transport_class, "__init__") as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=mock_cred, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) diff --git a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py deleted file mode 100644 index d506574..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py +++ /dev/null @@ -1,1981 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2020 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. -# -import os -import mock - -import grpc -from grpc.experimental import aio -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule - - -from google.api_core import client_options -from google.api_core import exceptions as core_exceptions -from google.api_core import gapic_v1 -from google.api_core import grpc_helpers -from google.api_core import grpc_helpers_async -from google.api_core import path_template -from google.auth import credentials as ga_credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.debugger_v2.services.debugger2 import Debugger2AsyncClient -from google.cloud.debugger_v2.services.debugger2 import Debugger2Client -from google.cloud.debugger_v2.services.debugger2 import transports -from google.cloud.debugger_v2.types import data -from google.cloud.debugger_v2.types import debugger -from google.oauth2 import service_account -from google.protobuf import timestamp_pb2 # type: ignore -from google.protobuf import wrappers_pb2 # type: ignore -import google.auth - - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert Debugger2Client._get_default_mtls_endpoint(None) is None - assert Debugger2Client._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert Debugger2Client._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert Debugger2Client._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert Debugger2Client._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert Debugger2Client._get_default_mtls_endpoint(non_googleapi) == non_googleapi - - -@pytest.mark.parametrize("client_class", [ - Debugger2Client, - Debugger2AsyncClient, -]) -def test_debugger2_client_from_service_account_info(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'clouddebugger.googleapis.com:443' - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.Debugger2GrpcTransport, "grpc"), - (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_debugger2_client_service_account_always_use_jwt(transport_class, transport_name): - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=True) - use_jwt.assert_called_once_with(True) - - with mock.patch.object(service_account.Credentials, 'with_always_use_jwt_access', create=True) as use_jwt: - creds = service_account.Credentials(None, None, None) - transport = transport_class(credentials=creds, always_use_jwt_access=False) - use_jwt.assert_not_called() - - -@pytest.mark.parametrize("client_class", [ - Debugger2Client, - Debugger2AsyncClient, -]) -def test_debugger2_client_from_service_account_file(client_class): - creds = ga_credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'clouddebugger.googleapis.com:443' - - -def test_debugger2_client_get_transport_class(): - transport = Debugger2Client.get_transport_class() - available_transports = [ - transports.Debugger2GrpcTransport, - ] - assert transport in available_transports - - transport = Debugger2Client.get_transport_class("grpc") - assert transport == transports.Debugger2GrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (Debugger2Client, transports.Debugger2GrpcTransport, "grpc"), - (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), -]) -@mock.patch.object(Debugger2Client, "DEFAULT_ENDPOINT", modify_default_endpoint(Debugger2Client)) -@mock.patch.object(Debugger2AsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(Debugger2AsyncClient)) -def test_debugger2_client_client_options(client_class, transport_class, transport_name): - # Check that if channel is provided we won't create a new one. - with mock.patch.object(Debugger2Client, 'get_transport_class') as gtc: - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials() - ) - client = client_class(transport=transport) - gtc.assert_not_called() - - # Check that if channel is provided via str we will create a new one. - with mock.patch.object(Debugger2Client, 'get_transport_class') as gtc: - client = client_class(transport=transport_name) - gtc.assert_called() - - # Check the case api_endpoint is provided. - options = client_options.ClientOptions(api_endpoint="squid.clam.whelk") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name, client_options=options) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT is - # "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_MTLS_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError): - client = client_class(transport=transport_name) - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError): - client = client_class(transport=transport_name) - - # Check the case quota_project_id is provided - options = client_options.ClientOptions(quota_project_id="octopus") - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,use_client_cert_env", [ - (Debugger2Client, transports.Debugger2GrpcTransport, "grpc", "true"), - (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", "true"), - (Debugger2Client, transports.Debugger2GrpcTransport, "grpc", "false"), - (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", "false"), -]) -@mock.patch.object(Debugger2Client, "DEFAULT_ENDPOINT", modify_default_endpoint(Debugger2Client)) -@mock.patch.object(Debugger2AsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(Debugger2AsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_debugger2_client_mtls_env_auto(client_class, transport_class, transport_name, use_client_cert_env): - # This tests the endpoint autoswitch behavior. Endpoint is autoswitched to the default - # mtls endpoint, if GOOGLE_API_USE_CLIENT_CERTIFICATE is "true" and client cert exists. - - # Check the case client_cert_source is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - options = client_options.ClientOptions(client_cert_source=client_cert_source_callback) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client.DEFAULT_ENDPOINT - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client.DEFAULT_ENDPOINT - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # Check the case client_cert_source and ADC client cert are not provided. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch("google.auth.transport.mtls.has_default_client_cert_source", return_value=False): - patched.return_value = None - client = client_class(transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -@pytest.mark.parametrize("client_class", [ - Debugger2Client, Debugger2AsyncClient -]) -@mock.patch.object(Debugger2Client, "DEFAULT_ENDPOINT", modify_default_endpoint(Debugger2Client)) -@mock.patch.object(Debugger2AsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(Debugger2AsyncClient)) -def test_debugger2_client_get_mtls_endpoint_and_cert_source(client_class): - mock_client_cert_source = mock.Mock() - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "true". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source == mock_client_cert_source - - # Test the case GOOGLE_API_USE_CLIENT_CERTIFICATE is "false". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): - mock_client_cert_source = mock.Mock() - mock_api_endpoint = "foo" - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=mock_api_endpoint) - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source(options) - assert api_endpoint == mock_api_endpoint - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "never". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "always". - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert doesn't exist. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=False): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_ENDPOINT - assert cert_source is None - - # Test the case GOOGLE_API_USE_MTLS_ENDPOINT is "auto" and default cert exists. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=mock_client_cert_source): - api_endpoint, cert_source = client_class.get_mtls_endpoint_and_cert_source() - assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - assert cert_source == mock_client_cert_source - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (Debugger2Client, transports.Debugger2GrpcTransport, "grpc"), - (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_debugger2_client_client_options_scopes(client_class, transport_class, transport_name): - # Check the case scopes are provided. - options = client_options.ClientOptions( - scopes=["1", "2"], - ) - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (Debugger2Client, transports.Debugger2GrpcTransport, "grpc", grpc_helpers), - (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_debugger2_client_client_options_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - -def test_debugger2_client_client_options_from_dict(): - with mock.patch('google.cloud.debugger_v2.services.debugger2.transports.Debugger2GrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = Debugger2Client( - client_options={'api_endpoint': 'squid.clam.whelk'} - ) - grpc_transport.assert_called_once_with( - credentials=None, - credentials_file=None, - host="squid.clam.whelk", - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name,grpc_helpers", [ - (Debugger2Client, transports.Debugger2GrpcTransport, "grpc", grpc_helpers), - (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_debugger2_client_create_channel_credentials_file(client_class, transport_class, transport_name, grpc_helpers): - # Check the case credentials file is provided. - options = client_options.ClientOptions( - credentials_file="credentials.json" - ) - - with mock.patch.object(transport_class, '__init__') as patched: - patched.return_value = None - client = client_class(client_options=options, transport=transport_name) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) - - # test that the credentials from file are saved and used as the credentials. - with mock.patch.object( - google.auth, "load_credentials_from_file", autospec=True - ) as load_creds, mock.patch.object( - google.auth, "default", autospec=True - ) as adc, mock.patch.object( - grpc_helpers, "create_channel" - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - file_creds = ga_credentials.AnonymousCredentials() - load_creds.return_value = (file_creds, None) - adc.return_value = (creds, None) - client = client_class(client_options=options, transport=transport_name) - create_channel.assert_called_with( - "clouddebugger.googleapis.com:443", - credentials=file_creds, - credentials_file=None, - quota_project_id=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud_debugger', -), - scopes=None, - default_host="clouddebugger.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.SetBreakpointRequest, - dict, -]) -def test_set_breakpoint(request_type, transport: str = 'grpc'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = debugger.SetBreakpointResponse( - ) - response = client.set_breakpoint(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.SetBreakpointRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.SetBreakpointResponse) - - -def test_set_breakpoint_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - client.set_breakpoint() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.SetBreakpointRequest() - - -@pytest.mark.asyncio -async def test_set_breakpoint_async(transport: str = 'grpc_asyncio', request_type=debugger.SetBreakpointRequest): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse( - )) - response = await client.set_breakpoint(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.SetBreakpointRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.SetBreakpointResponse) - - -@pytest.mark.asyncio -async def test_set_breakpoint_async_from_dict(): - await test_set_breakpoint_async(request_type=dict) - - -def test_set_breakpoint_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = debugger.SetBreakpointResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.set_breakpoint( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - client_version='client_version_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee_id - mock_val = 'debuggee_id_value' - assert arg == mock_val - arg = args[0].breakpoint_ - mock_val = data.Breakpoint(id='id_value') - assert arg == mock_val - arg = args[0].client_version - mock_val = 'client_version_value' - assert arg == mock_val - - -def test_set_breakpoint_flattened_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.set_breakpoint( - debugger.SetBreakpointRequest(), - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - client_version='client_version_value', - ) - - -@pytest.mark.asyncio -async def test_set_breakpoint_flattened_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = debugger.SetBreakpointResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.set_breakpoint( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - client_version='client_version_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee_id - mock_val = 'debuggee_id_value' - assert arg == mock_val - arg = args[0].breakpoint_ - mock_val = data.Breakpoint(id='id_value') - assert arg == mock_val - arg = args[0].client_version - mock_val = 'client_version_value' - assert arg == mock_val - - -@pytest.mark.asyncio -async def test_set_breakpoint_flattened_error_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.set_breakpoint( - debugger.SetBreakpointRequest(), - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - client_version='client_version_value', - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.GetBreakpointRequest, - dict, -]) -def test_get_breakpoint(request_type, transport: str = 'grpc'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = debugger.GetBreakpointResponse( - ) - response = client.get_breakpoint(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.GetBreakpointRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.GetBreakpointResponse) - - -def test_get_breakpoint_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - client.get_breakpoint() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.GetBreakpointRequest() - - -@pytest.mark.asyncio -async def test_get_breakpoint_async(transport: str = 'grpc_asyncio', request_type=debugger.GetBreakpointRequest): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse( - )) - response = await client.get_breakpoint(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.GetBreakpointRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.GetBreakpointResponse) - - -@pytest.mark.asyncio -async def test_get_breakpoint_async_from_dict(): - await test_get_breakpoint_async(request_type=dict) - - -def test_get_breakpoint_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = debugger.GetBreakpointResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_breakpoint( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee_id - mock_val = 'debuggee_id_value' - assert arg == mock_val - arg = args[0].breakpoint_id - mock_val = 'breakpoint_id_value' - assert arg == mock_val - arg = args[0].client_version - mock_val = 'client_version_value' - assert arg == mock_val - - -def test_get_breakpoint_flattened_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.get_breakpoint( - debugger.GetBreakpointRequest(), - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - - -@pytest.mark.asyncio -async def test_get_breakpoint_flattened_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = debugger.GetBreakpointResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_breakpoint( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee_id - mock_val = 'debuggee_id_value' - assert arg == mock_val - arg = args[0].breakpoint_id - mock_val = 'breakpoint_id_value' - assert arg == mock_val - arg = args[0].client_version - mock_val = 'client_version_value' - assert arg == mock_val - - -@pytest.mark.asyncio -async def test_get_breakpoint_flattened_error_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.get_breakpoint( - debugger.GetBreakpointRequest(), - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.DeleteBreakpointRequest, - dict, -]) -def test_delete_breakpoint(request_type, transport: str = 'grpc'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_breakpoint(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.DeleteBreakpointRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_breakpoint_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - client.delete_breakpoint() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.DeleteBreakpointRequest() - - -@pytest.mark.asyncio -async def test_delete_breakpoint_async(transport: str = 'grpc_asyncio', request_type=debugger.DeleteBreakpointRequest): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_breakpoint(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.DeleteBreakpointRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_delete_breakpoint_async_from_dict(): - await test_delete_breakpoint_async(request_type=dict) - - -def test_delete_breakpoint_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.delete_breakpoint( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee_id - mock_val = 'debuggee_id_value' - assert arg == mock_val - arg = args[0].breakpoint_id - mock_val = 'breakpoint_id_value' - assert arg == mock_val - arg = args[0].client_version - mock_val = 'client_version_value' - assert arg == mock_val - - -def test_delete_breakpoint_flattened_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.delete_breakpoint( - debugger.DeleteBreakpointRequest(), - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - - -@pytest.mark.asyncio -async def test_delete_breakpoint_flattened_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.delete_breakpoint( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee_id - mock_val = 'debuggee_id_value' - assert arg == mock_val - arg = args[0].breakpoint_id - mock_val = 'breakpoint_id_value' - assert arg == mock_val - arg = args[0].client_version - mock_val = 'client_version_value' - assert arg == mock_val - - -@pytest.mark.asyncio -async def test_delete_breakpoint_flattened_error_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.delete_breakpoint( - debugger.DeleteBreakpointRequest(), - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.ListBreakpointsRequest, - dict, -]) -def test_list_breakpoints(request_type, transport: str = 'grpc'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = debugger.ListBreakpointsResponse( - next_wait_token='next_wait_token_value', - ) - response = client.list_breakpoints(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.ListBreakpointsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.ListBreakpointsResponse) - assert response.next_wait_token == 'next_wait_token_value' - - -def test_list_breakpoints_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - client.list_breakpoints() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.ListBreakpointsRequest() - - -@pytest.mark.asyncio -async def test_list_breakpoints_async(transport: str = 'grpc_asyncio', request_type=debugger.ListBreakpointsRequest): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse( - next_wait_token='next_wait_token_value', - )) - response = await client.list_breakpoints(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.ListBreakpointsRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.ListBreakpointsResponse) - assert response.next_wait_token == 'next_wait_token_value' - - -@pytest.mark.asyncio -async def test_list_breakpoints_async_from_dict(): - await test_list_breakpoints_async(request_type=dict) - - -def test_list_breakpoints_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = debugger.ListBreakpointsResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_breakpoints( - debuggee_id='debuggee_id_value', - client_version='client_version_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee_id - mock_val = 'debuggee_id_value' - assert arg == mock_val - arg = args[0].client_version - mock_val = 'client_version_value' - assert arg == mock_val - - -def test_list_breakpoints_flattened_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.list_breakpoints( - debugger.ListBreakpointsRequest(), - debuggee_id='debuggee_id_value', - client_version='client_version_value', - ) - - -@pytest.mark.asyncio -async def test_list_breakpoints_flattened_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = debugger.ListBreakpointsResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_breakpoints( - debuggee_id='debuggee_id_value', - client_version='client_version_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].debuggee_id - mock_val = 'debuggee_id_value' - assert arg == mock_val - arg = args[0].client_version - mock_val = 'client_version_value' - assert arg == mock_val - - -@pytest.mark.asyncio -async def test_list_breakpoints_flattened_error_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_breakpoints( - debugger.ListBreakpointsRequest(), - debuggee_id='debuggee_id_value', - client_version='client_version_value', - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.ListDebuggeesRequest, - dict, -]) -def test_list_debuggees(request_type, transport: str = 'grpc'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_debuggees), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = debugger.ListDebuggeesResponse( - ) - response = client.list_debuggees(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.ListDebuggeesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.ListDebuggeesResponse) - - -def test_list_debuggees_empty_call(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_debuggees), - '__call__') as call: - client.list_debuggees() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.ListDebuggeesRequest() - - -@pytest.mark.asyncio -async def test_list_debuggees_async(transport: str = 'grpc_asyncio', request_type=debugger.ListDebuggeesRequest): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Everything is optional in proto3 as far as the runtime is concerned, - # and we are mocking out the actual API, so just send an empty request. - request = request_type() - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_debuggees), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListDebuggeesResponse( - )) - response = await client.list_debuggees(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - assert args[0] == debugger.ListDebuggeesRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.ListDebuggeesResponse) - - -@pytest.mark.asyncio -async def test_list_debuggees_async_from_dict(): - await test_list_debuggees_async(request_type=dict) - - -def test_list_debuggees_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_debuggees), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = debugger.ListDebuggeesResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.list_debuggees( - project='project_value', - client_version='client_version_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - arg = args[0].project - mock_val = 'project_value' - assert arg == mock_val - arg = args[0].client_version - mock_val = 'client_version_value' - assert arg == mock_val - - -def test_list_debuggees_flattened_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - client.list_debuggees( - debugger.ListDebuggeesRequest(), - project='project_value', - client_version='client_version_value', - ) - - -@pytest.mark.asyncio -async def test_list_debuggees_flattened_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_debuggees), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = debugger.ListDebuggeesResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListDebuggeesResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.list_debuggees( - project='project_value', - client_version='client_version_value', - ) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - arg = args[0].project - mock_val = 'project_value' - assert arg == mock_val - arg = args[0].client_version - mock_val = 'client_version_value' - assert arg == mock_val - - -@pytest.mark.asyncio -async def test_list_debuggees_flattened_error_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Attempting to call a method with both a request object and flattened - # fields is an error. - with pytest.raises(ValueError): - await client.list_debuggees( - debugger.ListDebuggeesRequest(), - project='project_value', - client_version='client_version_value', - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.Debugger2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.Debugger2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = Debugger2Client( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.Debugger2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = Debugger2Client( - client_options=options, - transport=transport, - ) - - # It is an error to provide an api_key and a credential. - options = mock.Mock() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = Debugger2Client( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.Debugger2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = Debugger2Client( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.Debugger2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = Debugger2Client(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.Debugger2GrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.Debugger2GrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.Debugger2GrpcTransport, - transports.Debugger2GrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.Debugger2GrpcTransport, - ) - -def test_debugger2_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.Debugger2Transport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_debugger2_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.debugger_v2.services.debugger2.transports.Debugger2Transport.__init__') as Transport: - Transport.return_value = None - transport = transports.Debugger2Transport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'set_breakpoint', - 'get_breakpoint', - 'delete_breakpoint', - 'list_breakpoints', - 'list_debuggees', - ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - - with pytest.raises(NotImplementedError): - transport.close() - - -def test_debugger2_base_transport_with_credentials_file(): - # Instantiate the base transport with a credentials file - with mock.patch.object(google.auth, 'load_credentials_from_file', autospec=True) as load_creds, mock.patch('google.cloud.debugger_v2.services.debugger2.transports.Debugger2Transport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.Debugger2Transport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud_debugger', -), - quota_project_id="octopus", - ) - - -def test_debugger2_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. - with mock.patch.object(google.auth, 'default', autospec=True) as adc, mock.patch('google.cloud.debugger_v2.services.debugger2.transports.Debugger2Transport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.Debugger2Transport() - adc.assert_called_once() - - -def test_debugger2_auth_adc(): - # If no credentials are provided, we should use ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - Debugger2Client() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud_debugger', -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.Debugger2GrpcTransport, - transports.Debugger2GrpcAsyncIOTransport, - ], -) -def test_debugger2_transport_auth_adc(transport_class): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport_class(quota_project_id="octopus", scopes=["1", "2"]) - adc.assert_called_once_with( - scopes=["1", "2"], - default_scopes=( 'https://www.googleapis.com/auth/cloud-platform', 'https://www.googleapis.com/auth/cloud_debugger',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class,grpc_helpers", - [ - (transports.Debugger2GrpcTransport, grpc_helpers), - (transports.Debugger2GrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_debugger2_transport_create_channel(transport_class, grpc_helpers): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(google.auth, "default", autospec=True) as adc, mock.patch.object( - grpc_helpers, "create_channel", autospec=True - ) as create_channel: - creds = ga_credentials.AnonymousCredentials() - adc.return_value = (creds, None) - transport_class( - quota_project_id="octopus", - scopes=["1", "2"] - ) - - create_channel.assert_called_with( - "clouddebugger.googleapis.com:443", - credentials=creds, - credentials_file=None, - quota_project_id="octopus", - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud_debugger', -), - scopes=["1", "2"], - default_host="clouddebugger.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.Debugger2GrpcTransport, transports.Debugger2GrpcAsyncIOTransport]) -def test_debugger2_grpc_transport_client_cert_source_for_mtls( - transport_class -): - cred = ga_credentials.AnonymousCredentials() - - # Check ssl_channel_credentials is used if provided. - with mock.patch.object(transport_class, "create_channel") as mock_create_channel: - mock_ssl_channel_creds = mock.Mock() - transport_class( - host="squid.clam.whelk", - credentials=cred, - ssl_channel_credentials=mock_ssl_channel_creds - ) - mock_create_channel.assert_called_once_with( - "squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_channel_creds, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - # Check if ssl_channel_credentials is not provided, then client_cert_source_for_mtls - # is used. - with mock.patch.object(transport_class, "create_channel", return_value=mock.Mock()): - with mock.patch("grpc.ssl_channel_credentials") as mock_ssl_cred: - transport_class( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - expected_cert, expected_key = client_cert_source_callback() - mock_ssl_cred.assert_called_once_with( - certificate_chain=expected_cert, - private_key=expected_key - ) - - -def test_debugger2_host_no_port(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), - ) - assert client.transport._host == 'clouddebugger.googleapis.com:443' - - -def test_debugger2_host_with_port(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), - ) - assert client.transport._host == 'clouddebugger.googleapis.com:8000' - -def test_debugger2_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.Debugger2GrpcTransport( - host="squid.clam.whelk", - channel=channel, - ) - assert transport.grpc_channel == channel - assert transport._host == "squid.clam.whelk:443" - assert transport._ssl_channel_credentials == None - - -def test_debugger2_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.Debugger2GrpcAsyncIOTransport( - host="squid.clam.whelk", - channel=channel, - ) - assert transport.grpc_channel == channel - assert transport._host == "squid.clam.whelk:443" - assert transport._ssl_channel_credentials == None - - -# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are -# removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.Debugger2GrpcTransport, transports.Debugger2GrpcAsyncIOTransport]) -def test_debugger2_transport_channel_mtls_with_client_cert_source( - transport_class -): - with mock.patch("grpc.ssl_channel_credentials", autospec=True) as grpc_ssl_channel_cred: - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_ssl_cred = mock.Mock() - grpc_ssl_channel_cred.return_value = mock_ssl_cred - - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - - cred = ga_credentials.AnonymousCredentials() - with pytest.warns(DeprecationWarning): - with mock.patch.object(google.auth, 'default') as adc: - adc.return_value = (cred, None) - transport = transport_class( - host="squid.clam.whelk", - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=client_cert_source_callback, - ) - adc.assert_called_once() - - grpc_ssl_channel_cred.assert_called_once_with( - certificate_chain=b"cert bytes", private_key=b"key bytes" - ) - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - assert transport._ssl_channel_credentials == mock_ssl_cred - - -# Remove this test when deprecated arguments (api_mtls_endpoint, client_cert_source) are -# removed from grpc/grpc_asyncio transport constructor. -@pytest.mark.parametrize("transport_class", [transports.Debugger2GrpcTransport, transports.Debugger2GrpcAsyncIOTransport]) -def test_debugger2_transport_channel_mtls_with_adc( - transport_class -): - mock_ssl_cred = mock.Mock() - with mock.patch.multiple( - "google.auth.transport.grpc.SslCredentials", - __init__=mock.Mock(return_value=None), - ssl_credentials=mock.PropertyMock(return_value=mock_ssl_cred), - ): - with mock.patch.object(transport_class, "create_channel") as grpc_create_channel: - mock_grpc_channel = mock.Mock() - grpc_create_channel.return_value = mock_grpc_channel - mock_cred = mock.Mock() - - with pytest.warns(DeprecationWarning): - transport = transport_class( - host="squid.clam.whelk", - credentials=mock_cred, - api_mtls_endpoint="mtls.squid.clam.whelk", - client_cert_source=None, - ) - - grpc_create_channel.assert_called_once_with( - "mtls.squid.clam.whelk:443", - credentials=mock_cred, - credentials_file=None, - scopes=None, - ssl_credentials=mock_ssl_cred, - quota_project_id=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - assert transport.grpc_channel == mock_grpc_channel - - -def test_common_billing_account_path(): - billing_account = "squid" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = Debugger2Client.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "clam", - } - path = Debugger2Client.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = Debugger2Client.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "whelk" - expected = "folders/{folder}".format(folder=folder, ) - actual = Debugger2Client.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "octopus", - } - path = Debugger2Client.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = Debugger2Client.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "oyster" - expected = "organizations/{organization}".format(organization=organization, ) - actual = Debugger2Client.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "nudibranch", - } - path = Debugger2Client.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = Debugger2Client.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "cuttlefish" - expected = "projects/{project}".format(project=project, ) - actual = Debugger2Client.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "mussel", - } - path = Debugger2Client.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = Debugger2Client.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "winkle" - location = "nautilus" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = Debugger2Client.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "scallop", - "location": "abalone", - } - path = Debugger2Client.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = Debugger2Client.parse_common_location_path(path) - assert expected == actual - - -def test_client_with_default_client_info(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.Debugger2Transport, '_prep_wrapped_messages') as prep: - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.Debugger2Transport, '_prep_wrapped_messages') as prep: - transport_class = Debugger2Client.get_transport_class() - transport = transport_class( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - -@pytest.mark.asyncio -async def test_transport_close_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc_asyncio", - ) - with mock.patch.object(type(getattr(client.transport, "grpc_channel")), "close") as close: - async with client: - close.assert_not_called() - close.assert_called_once() - -def test_transport_close(): - transports = { - "grpc": "_grpc_channel", - } - - for transport, close_name in transports.items(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - with mock.patch.object(type(getattr(client.transport, close_name)), "close") as close: - with client: - close.assert_not_called() - close.assert_called_once() - -def test_client_ctx(): - transports = [ - 'grpc', - ] - for transport in transports: - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport - ) - # Test client calls underlying transport. - with mock.patch.object(type(client.transport), "close") as close: - close.assert_not_called() - with client: - pass - close.assert_called() - -@pytest.mark.parametrize("client_class,transport_class", [ - (Debugger2Client, transports.Debugger2GrpcTransport), - (Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport), -]) -def test_api_key_credentials(client_class, transport_class): - with mock.patch.object( - google.auth._default, "get_api_key_credentials", create=True - ) as get_api_key_credentials: - mock_cred = mock.Mock() - get_api_key_credentials.return_value = mock_cred - options = client_options.ClientOptions() - options.api_key = "api_key" - with mock.patch.object(transport_class, "__init__") as patched: - patched.return_value = None - client = client_class(client_options=options) - patched.assert_called_once_with( - credentials=mock_cred, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - ) diff --git a/tests/unit/gapic/debugger_v2/test_controller2.py b/tests/unit/gapic/debugger_v2/test_controller2.py index 711cd2d..8008f55 100644 --- a/tests/unit/gapic/debugger_v2/test_controller2.py +++ b/tests/unit/gapic/debugger_v2/test_controller2.py @@ -496,21 +496,23 @@ def test_controller2_client_client_options_scopes( @pytest.mark.parametrize( - "client_class,transport_class,transport_name", + "client_class,transport_class,transport_name,grpc_helpers", [ - (Controller2Client, transports.Controller2GrpcTransport, "grpc"), + (Controller2Client, transports.Controller2GrpcTransport, "grpc", grpc_helpers), ( Controller2AsyncClient, transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", + grpc_helpers_async, ), ], ) def test_controller2_client_client_options_credentials_file( - client_class, transport_class, transport_name + client_class, transport_class, transport_name, grpc_helpers ): # Check the case credentials file is provided. options = client_options.ClientOptions(credentials_file="credentials.json") + with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None client = client_class(client_options=options, transport=transport_name) @@ -544,6 +546,70 @@ def test_controller2_client_client_options_from_dict(): ) +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + (Controller2Client, transports.Controller2GrpcTransport, "grpc", grpc_helpers), + ( + Controller2AsyncClient, + transports.Controller2GrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_controller2_client_create_channel_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "clouddebugger.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_debugger", + ), + scopes=None, + default_host="clouddebugger.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + @pytest.mark.parametrize("request_type", [controller.RegisterDebuggeeRequest, dict,]) def test_register_debuggee(request_type, transport: str = "grpc"): client = Controller2Client( diff --git a/tests/unit/gapic/debugger_v2/test_debugger2.py b/tests/unit/gapic/debugger_v2/test_debugger2.py index 88932b0..dc0761c 100644 --- a/tests/unit/gapic/debugger_v2/test_debugger2.py +++ b/tests/unit/gapic/debugger_v2/test_debugger2.py @@ -491,21 +491,23 @@ def test_debugger2_client_client_options_scopes( @pytest.mark.parametrize( - "client_class,transport_class,transport_name", + "client_class,transport_class,transport_name,grpc_helpers", [ - (Debugger2Client, transports.Debugger2GrpcTransport, "grpc"), + (Debugger2Client, transports.Debugger2GrpcTransport, "grpc", grpc_helpers), ( Debugger2AsyncClient, transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", + grpc_helpers_async, ), ], ) def test_debugger2_client_client_options_credentials_file( - client_class, transport_class, transport_name + client_class, transport_class, transport_name, grpc_helpers ): # Check the case credentials file is provided. options = client_options.ClientOptions(credentials_file="credentials.json") + with mock.patch.object(transport_class, "__init__") as patched: patched.return_value = None client = client_class(client_options=options, transport=transport_name) @@ -539,6 +541,70 @@ def test_debugger2_client_client_options_from_dict(): ) +@pytest.mark.parametrize( + "client_class,transport_class,transport_name,grpc_helpers", + [ + (Debugger2Client, transports.Debugger2GrpcTransport, "grpc", grpc_helpers), + ( + Debugger2AsyncClient, + transports.Debugger2GrpcAsyncIOTransport, + "grpc_asyncio", + grpc_helpers_async, + ), + ], +) +def test_debugger2_client_create_channel_credentials_file( + client_class, transport_class, transport_name, grpc_helpers +): + # Check the case credentials file is provided. + options = client_options.ClientOptions(credentials_file="credentials.json") + + with mock.patch.object(transport_class, "__init__") as patched: + patched.return_value = None + client = client_class(client_options=options, transport=transport_name) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + ) + + # test that the credentials from file are saved and used as the credentials. + with mock.patch.object( + google.auth, "load_credentials_from_file", autospec=True + ) as load_creds, mock.patch.object( + google.auth, "default", autospec=True + ) as adc, mock.patch.object( + grpc_helpers, "create_channel" + ) as create_channel: + creds = ga_credentials.AnonymousCredentials() + file_creds = ga_credentials.AnonymousCredentials() + load_creds.return_value = (file_creds, None) + adc.return_value = (creds, None) + client = client_class(client_options=options, transport=transport_name) + create_channel.assert_called_with( + "clouddebugger.googleapis.com:443", + credentials=file_creds, + credentials_file=None, + quota_project_id=None, + default_scopes=( + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_debugger", + ), + scopes=None, + default_host="clouddebugger.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + @pytest.mark.parametrize("request_type", [debugger.SetBreakpointRequest, dict,]) def test_set_breakpoint(request_type, transport: str = "grpc"): client = Debugger2Client(