From 736ba71bd9aa077fb919cae4a77861dfe72b57ff Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 8 Feb 2023 22:44:49 +0000 Subject: [PATCH 01/10] feat: enable "rest" transport in Python for services supporting numeric enums PiperOrigin-RevId: 508143576 Source-Link: https://github.com/googleapis/googleapis/commit/7a702a989db3b413f39ff8994ca53fb38b6928c2 Source-Link: https://github.com/googleapis/googleapis-gen/commit/6ad1279c0e7aa787ac6b66c9fd4a210692edffcd Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNmFkMTI3OWMwZTdhYTc4N2FjNmI2NmM5ZmQ0YTIxMDY5MmVkZmZjZCJ9 --- owl-bot-staging/v2/.coveragerc | 13 + owl-bot-staging/v2/.flake8 | 33 + 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 | 6 + owl-bot-staging/v2/docs/index.rst | 7 + .../v2/google/cloud/debugger/__init__.py | 75 + .../v2/google/cloud/debugger/gapic_version.py | 16 + .../v2/google/cloud/debugger/py.typed | 2 + .../v2/google/cloud/debugger_v2/__init__.py | 76 + .../cloud/debugger_v2/gapic_metadata.json | 167 + .../google/cloud/debugger_v2/gapic_version.py | 16 + .../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 | 566 +++ .../services/controller2/client.py | 747 ++++ .../controller2/transports/__init__.py | 38 + .../services/controller2/transports/base.py | 191 + .../services/controller2/transports/grpc.py | 369 ++ .../controller2/transports/grpc_asyncio.py | 368 ++ .../services/controller2/transports/rest.py | 554 +++ .../services/debugger2/__init__.py | 22 + .../services/debugger2/async_client.py | 806 ++++ .../debugger_v2/services/debugger2/client.py | 973 +++++ .../services/debugger2/transports/__init__.py | 38 + .../services/debugger2/transports/base.py | 234 ++ .../services/debugger2/transports/grpc.py | 381 ++ .../debugger2/transports/grpc_asyncio.py | 380 ++ .../services/debugger2/transports/rest.py | 730 ++++ .../cloud/debugger_v2/types/__init__.py | 68 + .../cloud/debugger_v2/types/controller.py | 174 + .../v2/google/cloud/debugger_v2/types/data.py | 679 +++ .../cloud/debugger_v2/types/debugger.py | 313 ++ owl-bot-staging/v2/mypy.ini | 3 + owl-bot-staging/v2/noxfile.py | 184 + ...ntroller2_list_active_breakpoints_async.py | 52 + ...ontroller2_list_active_breakpoints_sync.py | 52 + ...ted_controller2_register_debuggee_async.py | 51 + ...ated_controller2_register_debuggee_sync.py | 51 + ...troller2_update_active_breakpoint_async.py | 52 + ...ntroller2_update_active_breakpoint_sync.py | 52 + ...rated_debugger2_delete_breakpoint_async.py | 52 + ...erated_debugger2_delete_breakpoint_sync.py | 52 + ...enerated_debugger2_get_breakpoint_async.py | 54 + ...generated_debugger2_get_breakpoint_sync.py | 54 + ...erated_debugger2_list_breakpoints_async.py | 53 + ...nerated_debugger2_list_breakpoints_sync.py | 53 + ...enerated_debugger2_list_debuggees_async.py | 53 + ...generated_debugger2_list_debuggees_sync.py | 53 + ...enerated_debugger2_set_breakpoint_async.py | 53 + ...generated_debugger2_set_breakpoint_sync.py | 53 + ...data_google.devtools.clouddebugger.v2.json | 1369 +++++++ .../v2/scripts/fixup_debugger_v2_keywords.py | 183 + owl-bot-staging/v2/setup.py | 90 + .../v2/testing/constraints-3.10.txt | 6 + .../v2/testing/constraints-3.11.txt | 6 + .../v2/testing/constraints-3.12.txt | 6 + .../v2/testing/constraints-3.7.txt | 9 + .../v2/testing/constraints-3.8.txt | 6 + .../v2/testing/constraints-3.9.txt | 6 + 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 | 2551 ++++++++++++ .../unit/gapic/debugger_v2/test_debugger2.py | 3628 +++++++++++++++++ 71 files changed, 17478 insertions(+) create mode 100644 owl-bot-staging/v2/.coveragerc create mode 100644 owl-bot-staging/v2/.flake8 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/gapic_version.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/gapic_version.py 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/controller2/transports/rest.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/services/debugger2/transports/rest.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/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json 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/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.9.txt 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..9620812 --- /dev/null +++ b/owl-bot-staging/v2/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/debugger/__init__.py + google/cloud/debugger/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v2/.flake8 b/owl-bot-staging/v2/.flake8 new file mode 100644 index 0000000..29227d4 --- /dev/null +++ b/owl-bot-staging/v2/.flake8 @@ -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 +# +# https://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. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py 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..4ad5ea1 --- /dev/null +++ b/owl-bot-staging/v2/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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"2022, 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..0106467 --- /dev/null +++ b/owl-bot-staging/v2/docs/debugger_v2/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Debugger v2 API +====================================== + +.. automodule:: google.cloud.debugger_v2.types + :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..1228468 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger/__init__.py @@ -0,0 +1,75 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 import gapic_version as package_version + +__version__ = package_version.__version__ + + +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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +__version__ = "0.1.0" # {x-release-please-version} 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..c774017 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 import gapic_version as package_version + +__version__ = package_version.__version__ + + +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..f0d8a90 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json @@ -0,0 +1,167 @@ + { + "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" + ] + } + } + }, + "rest": { + "libraryClient": "Controller2Client", + "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" + ] + } + } + }, + "rest": { + "libraryClient": "Debugger2Client", + "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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +__version__ = "0.1.0" # {x-release-please-version} 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..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..e010a73 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..aa29878 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py @@ -0,0 +1,566 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 variable 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: Optional[ga_credentials.Credentials] = None, + transport: Union[str, Controller2Transport] = "grpc_asyncio", + client_options: Optional[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: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, + *, + debuggee: Optional[data.Debuggee] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = await client.register_debuggee(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint.id", request.breakpoint.id), + )), + ) + + # 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() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..7330718 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py @@ -0,0 +1,747 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 +from .transports.rest import Controller2RestTransport + + +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 + _transport_registry["rest"] = Controller2RestTransport + + def get_transport_class(cls, + label: Optional[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 variable 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: Optional[Union[str, Controller2Transport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() + client_options = cast(client_options_lib.ClientOptions, client_options) + + 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, + api_audience=client_options.api_audience, + ) + + def register_debuggee(self, + request: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, + *, + debuggee: Optional[data.Debuggee] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = client.register_debuggee(request=request) + + # Handle the response + print(response) + + 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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_active_breakpoint(self, + request: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint.id", request.breakpoint.id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "Controller2Client": + 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() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..0381ff4 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +from .rest import Controller2RestTransport +from .rest import Controller2RestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] +_transport_registry['grpc'] = Controller2GrpcTransport +_transport_registry['grpc_asyncio'] = Controller2GrpcAsyncIOTransport +_transport_registry['rest'] = Controller2RestTransport + +__all__ = ( + 'Controller2Transport', + 'Controller2GrpcTransport', + 'Controller2GrpcAsyncIOTransport', + 'Controller2RestTransport', + 'Controller2RestInterceptor', +) 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..8e480a6 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py @@ -0,0 +1,191 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +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: Optional[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, + api_audience: Optional[str] = None, + **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. + """ + + 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) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # 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 + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + 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() + + @property + def kind(self) -> str: + 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..09e2efa --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py @@ -0,0 +1,369 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[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() + + @property + def kind(self) -> str: + return "grpc" + + +__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..ae65db1 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py @@ -0,0 +1,368 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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/controller2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py new file mode 100644 index 0000000..b0202db --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py @@ -0,0 +1,554 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +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 .base import Controller2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class Controller2RestInterceptor: + """Interceptor for Controller2. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the Controller2RestTransport. + + .. code-block:: python + class MyCustomController2Interceptor(Controller2RestInterceptor): + def pre_list_active_breakpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_active_breakpoints(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_register_debuggee(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_register_debuggee(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_active_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_active_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + transport = Controller2RestTransport(interceptor=MyCustomController2Interceptor()) + client = Controller2Client(transport=transport) + + + """ + def pre_list_active_breakpoints(self, request: controller.ListActiveBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.ListActiveBreakpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_active_breakpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_list_active_breakpoints(self, response: controller.ListActiveBreakpointsResponse) -> controller.ListActiveBreakpointsResponse: + """Post-rpc interceptor for list_active_breakpoints + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + def pre_register_debuggee(self, request: controller.RegisterDebuggeeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.RegisterDebuggeeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for register_debuggee + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_register_debuggee(self, response: controller.RegisterDebuggeeResponse) -> controller.RegisterDebuggeeResponse: + """Post-rpc interceptor for register_debuggee + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + def pre_update_active_breakpoint(self, request: controller.UpdateActiveBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.UpdateActiveBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_active_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_update_active_breakpoint(self, response: controller.UpdateActiveBreakpointResponse) -> controller.UpdateActiveBreakpointResponse: + """Post-rpc interceptor for update_active_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class Controller2RestStub: + _session: AuthorizedSession + _host: str + _interceptor: Controller2RestInterceptor + + +class Controller2RestTransport(Controller2Transport): + """REST 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 JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[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, + url_scheme: str = 'https', + interceptor: Optional[Controller2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> 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 ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` 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 are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or Controller2RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _ListActiveBreakpoints(Controller2RestStub): + def __hash__(self): + return hash("ListActiveBreakpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.ListActiveBreakpointsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.ListActiveBreakpointsResponse: + r"""Call the list active breakpoints method over HTTP. + + Args: + request (~.controller.ListActiveBreakpointsRequest): + The request object. Request to list active breakpoints. + 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: + ~.controller.ListActiveBreakpointsResponse: + Response for listing active + breakpoints. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints', + }, + ] + request, metadata = self._interceptor.pre_list_active_breakpoints(request, metadata) + pb_request = controller.ListActiveBreakpointsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.ListActiveBreakpointsResponse() + pb_resp = controller.ListActiveBreakpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_active_breakpoints(resp) + return resp + + class _RegisterDebuggee(Controller2RestStub): + def __hash__(self): + return hash("RegisterDebuggee") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.RegisterDebuggeeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.RegisterDebuggeeResponse: + r"""Call the register debuggee method over HTTP. + + Args: + request (~.controller.RegisterDebuggeeRequest): + The request object. Request to register a debuggee. + 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: + ~.controller.RegisterDebuggeeResponse: + Response for registering a debuggee. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/controller/debuggees/register', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_register_debuggee(request, metadata) + pb_request = controller.RegisterDebuggeeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.RegisterDebuggeeResponse() + pb_resp = controller.RegisterDebuggeeResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_register_debuggee(resp) + return resp + + class _UpdateActiveBreakpoint(Controller2RestStub): + def __hash__(self): + return hash("UpdateActiveBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.UpdateActiveBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.UpdateActiveBreakpointResponse: + r"""Call the update active breakpoint method over HTTP. + + Args: + request (~.controller.UpdateActiveBreakpointRequest): + The request object. Request to update an active + breakpoint. + + 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: + ~.controller.UpdateActiveBreakpointResponse: + Response for updating an active + breakpoint. The message is defined to + allow future extensions. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'put', + 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_update_active_breakpoint(request, metadata) + pb_request = controller.UpdateActiveBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.UpdateActiveBreakpointResponse() + pb_resp = controller.UpdateActiveBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_active_breakpoint(resp) + return resp + + @property + def list_active_breakpoints(self) -> Callable[ + [controller.ListActiveBreakpointsRequest], + controller.ListActiveBreakpointsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListActiveBreakpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def register_debuggee(self) -> Callable[ + [controller.RegisterDebuggeeRequest], + controller.RegisterDebuggeeResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RegisterDebuggee(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_active_breakpoint(self) -> Callable[ + [controller.UpdateActiveBreakpointRequest], + controller.UpdateActiveBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateActiveBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'Controller2RestTransport', +) 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..5d7f609 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..257c378 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py @@ -0,0 +1,806 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 variable 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: Optional[ga_credentials.Credentials] = None, + transport: Union[str, Debugger2Transport] = "grpc_asyncio", + client_options: Optional[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: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Sets the breakpoint to the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.set_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Gets breakpoint information. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.get_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # 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: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the breakpoint from the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + await client.delete_breakpoint(request=request) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def list_breakpoints(self, + request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Lists all breakpoints for the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_breakpoints(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, + *, + project: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Lists all the debuggees that the user has access to. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_debuggees(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..7e52f8d --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py @@ -0,0 +1,973 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 +from .transports.rest import Debugger2RestTransport + + +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 + _transport_registry["rest"] = Debugger2RestTransport + + def get_transport_class(cls, + label: Optional[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 variable 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: Optional[Union[str, Debugger2Transport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() + client_options = cast(client_options_lib.ClientOptions, client_options) + + 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, + api_audience=client_options.api_audience, + ) + + def set_breakpoint(self, + request: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Sets the breakpoint to the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.set_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_breakpoint(self, + request: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Gets breakpoint information. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.get_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_breakpoint(self, + request: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the breakpoint from the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + client.delete_breakpoint(request=request) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def list_breakpoints(self, + request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Lists all breakpoints for the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_breakpoints(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_debuggees(self, + request: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, + *, + project: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Lists all the debuggees that the user has access to. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_debuggees(request=request) + + # Handle the response + print(response) + + 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) -> "Debugger2Client": + 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() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..cd9dd46 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +from .rest import Debugger2RestTransport +from .rest import Debugger2RestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] +_transport_registry['grpc'] = Debugger2GrpcTransport +_transport_registry['grpc_asyncio'] = Debugger2GrpcAsyncIOTransport +_transport_registry['rest'] = Debugger2RestTransport + +__all__ = ( + 'Debugger2Transport', + 'Debugger2GrpcTransport', + 'Debugger2GrpcAsyncIOTransport', + 'Debugger2RestTransport', + 'Debugger2RestInterceptor', +) 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..c4afc0c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py @@ -0,0 +1,234 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +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: Optional[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, + api_audience: Optional[str] = None, + **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. + """ + + 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) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # 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 + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + 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() + + @property + def kind(self) -> str: + 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..fbb3374 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py @@ -0,0 +1,381 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[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() + + @property + def kind(self) -> str: + return "grpc" + + +__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..eb6eadc --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py @@ -0,0 +1,380 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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/services/debugger2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py new file mode 100644 index 0000000..8ae4962 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py @@ -0,0 +1,730 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +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 debugger +from google.protobuf import empty_pb2 # type: ignore + +from .base import Debugger2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class Debugger2RestInterceptor: + """Interceptor for Debugger2. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the Debugger2RestTransport. + + .. code-block:: python + class MyCustomDebugger2Interceptor(Debugger2RestInterceptor): + def pre_delete_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_breakpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_breakpoints(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_debuggees(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_debuggees(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_set_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_set_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + transport = Debugger2RestTransport(interceptor=MyCustomDebugger2Interceptor()) + client = Debugger2Client(transport=transport) + + + """ + def pre_delete_breakpoint(self, request: debugger.DeleteBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.DeleteBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def pre_get_breakpoint(self, request: debugger.GetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.GetBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_get_breakpoint(self, response: debugger.GetBreakpointResponse) -> debugger.GetBreakpointResponse: + """Post-rpc interceptor for get_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_list_breakpoints(self, request: debugger.ListBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListBreakpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_breakpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_list_breakpoints(self, response: debugger.ListBreakpointsResponse) -> debugger.ListBreakpointsResponse: + """Post-rpc interceptor for list_breakpoints + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_list_debuggees(self, request: debugger.ListDebuggeesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListDebuggeesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_debuggees + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_list_debuggees(self, response: debugger.ListDebuggeesResponse) -> debugger.ListDebuggeesResponse: + """Post-rpc interceptor for list_debuggees + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_set_breakpoint(self, request: debugger.SetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.SetBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for set_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_set_breakpoint(self, response: debugger.SetBreakpointResponse) -> debugger.SetBreakpointResponse: + """Post-rpc interceptor for set_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class Debugger2RestStub: + _session: AuthorizedSession + _host: str + _interceptor: Debugger2RestInterceptor + + +class Debugger2RestTransport(Debugger2Transport): + """REST 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 JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[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, + url_scheme: str = 'https', + interceptor: Optional[Debugger2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> 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 ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` 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 are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or Debugger2RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _DeleteBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("DeleteBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.DeleteBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the delete breakpoint method over HTTP. + + Args: + request (~.debugger.DeleteBreakpointRequest): + The request object. Request to delete a breakpoint. + 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. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', + }, + ] + request, metadata = self._interceptor.pre_delete_breakpoint(request, metadata) + pb_request = debugger.DeleteBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("GetBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.GetBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.GetBreakpointResponse: + r"""Call the get breakpoint method over HTTP. + + Args: + request (~.debugger.GetBreakpointRequest): + The request object. Request to get breakpoint + information. + + 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: + ~.debugger.GetBreakpointResponse: + Response for getting breakpoint + information. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', + }, + ] + request, metadata = self._interceptor.pre_get_breakpoint(request, metadata) + pb_request = debugger.GetBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.GetBreakpointResponse() + pb_resp = debugger.GetBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_breakpoint(resp) + return resp + + class _ListBreakpoints(Debugger2RestStub): + def __hash__(self): + return hash("ListBreakpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.ListBreakpointsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.ListBreakpointsResponse: + r"""Call the list breakpoints method over HTTP. + + Args: + request (~.debugger.ListBreakpointsRequest): + The request object. Request to list breakpoints. + 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: + ~.debugger.ListBreakpointsResponse: + Response for listing breakpoints. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints', + }, + ] + request, metadata = self._interceptor.pre_list_breakpoints(request, metadata) + pb_request = debugger.ListBreakpointsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.ListBreakpointsResponse() + pb_resp = debugger.ListBreakpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_breakpoints(resp) + return resp + + class _ListDebuggees(Debugger2RestStub): + def __hash__(self): + return hash("ListDebuggees") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "project" : "", "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.ListDebuggeesRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.ListDebuggeesResponse: + r"""Call the list debuggees method over HTTP. + + Args: + request (~.debugger.ListDebuggeesRequest): + The request object. Request to list debuggees. + 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: + ~.debugger.ListDebuggeesResponse: + Response for listing debuggees. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees', + }, + ] + request, metadata = self._interceptor.pre_list_debuggees(request, metadata) + pb_request = debugger.ListDebuggeesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.ListDebuggeesResponse() + pb_resp = debugger.ListDebuggeesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_debuggees(resp) + return resp + + class _SetBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("SetBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "breakpoint" : {}, "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.SetBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.SetBreakpointResponse: + r"""Call the set breakpoint method over HTTP. + + Args: + request (~.debugger.SetBreakpointRequest): + The request object. Request to set a breakpoint + 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: + ~.debugger.SetBreakpointResponse: + Response for setting a breakpoint. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/set', + 'body': 'breakpoint', + }, + ] + request, metadata = self._interceptor.pre_set_breakpoint(request, metadata) + pb_request = debugger.SetBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.SetBreakpointResponse() + pb_resp = debugger.SetBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_set_breakpoint(resp) + return resp + + @property + def delete_breakpoint(self) -> Callable[ + [debugger.DeleteBreakpointRequest], + empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_breakpoint(self) -> Callable[ + [debugger.GetBreakpointRequest], + debugger.GetBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_breakpoints(self) -> Callable[ + [debugger.ListBreakpointsRequest], + debugger.ListBreakpointsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListBreakpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_debuggees(self) -> Callable[ + [debugger.ListDebuggeesRequest], + debugger.ListDebuggeesResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListDebuggees(self._session, self._host, self._interceptor) # type: ignore + + @property + def set_breakpoint(self) -> Callable[ + [debugger.SetBreakpointRequest], + debugger.SetBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._SetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'Debugger2RestTransport', +) 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..9791b6c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py @@ -0,0 +1,68 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..9001c20 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py @@ -0,0 +1,174 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 typing import MutableMapping, MutableSequence + +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: data.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: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + wait_token: str = proto.Field( + proto.STRING, + number=2, + ) + success_on_timeout: bool = proto.Field( + proto.BOOL, + number=3, + ) + + +class ListActiveBreakpointsResponse(proto.Message): + r"""Response for listing active breakpoints. + + Attributes: + breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + next_wait_token: str = proto.Field( + proto.STRING, + number=2, + ) + wait_expired: bool = 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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_: data.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..4ab7f91 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py @@ -0,0 +1,679 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 typing import MutableMapping, MutableSequence + +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 (MutableSequence[str]): + Optional parameters to be embedded into the + message. + """ + + format_: str = proto.Field( + proto.STRING, + number=1, + ) + parameters: MutableSequence[str] = 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. + + Values: + UNSPECIFIED (0): + Status doesn't refer to any particular input. + BREAKPOINT_SOURCE_LOCATION (3): + Status applies to the breakpoint and is + related to its location. + BREAKPOINT_CONDITION (4): + Status applies to the breakpoint and is + related to its condition. + BREAKPOINT_EXPRESSION (7): + Status applies to the breakpoint and is + related to its expressions. + BREAKPOINT_AGE (8): + Status applies to the breakpoint and is + related to its age. + VARIABLE_NAME (5): + Status applies to the entire variable. + VARIABLE_VALUE (6): + Status applies to variable value (variable + name is valid). + """ + UNSPECIFIED = 0 + BREAKPOINT_SOURCE_LOCATION = 3 + BREAKPOINT_CONDITION = 4 + BREAKPOINT_EXPRESSION = 7 + BREAKPOINT_AGE = 8 + VARIABLE_NAME = 5 + VARIABLE_VALUE = 6 + + is_error: bool = proto.Field( + proto.BOOL, + number=1, + ) + refers_to: Reference = proto.Field( + proto.ENUM, + number=2, + enum=Reference, + ) + description: 'FormatMessage' = 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: str = proto.Field( + proto.STRING, + number=1, + ) + line: int = proto.Field( + proto.INT32, + number=2, + ) + column: int = 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 (MutableSequence[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: str = proto.Field( + proto.STRING, + number=1, + ) + value: str = proto.Field( + proto.STRING, + number=2, + ) + type_: str = proto.Field( + proto.STRING, + number=6, + ) + members: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='Variable', + ) + var_table_index: wrappers_pb2.Int32Value = proto.Field( + proto.MESSAGE, + number=4, + message=wrappers_pb2.Int32Value, + ) + status: 'StatusMessage' = 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 (MutableSequence[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_ (MutableSequence[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: str = proto.Field( + proto.STRING, + number=1, + ) + location: 'SourceLocation' = proto.Field( + proto.MESSAGE, + number=2, + message='SourceLocation', + ) + arguments: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='Variable', + ) + locals_: MutableSequence['Variable'] = 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 (MutableSequence[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 (MutableSequence[google.cloud.debugger_v2.types.StackFrame]): + The stack at breakpoint time, where stack_frames[0] + represents the most recently entered function. + evaluated_expressions (MutableSequence[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 (MutableSequence[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 (MutableMapping[str, str]): + 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. + + Values: + CAPTURE (0): + Capture stack frame and variables and update + the breakpoint. The data is only captured once. + After that the breakpoint is set in a final + state. + LOG (1): + Log each breakpoint hit. The breakpoint + remains active until deleted or expired. + """ + CAPTURE = 0 + LOG = 1 + + class LogLevel(proto.Enum): + r"""Log severity levels. + + Values: + INFO (0): + Information log message. + WARNING (1): + Warning log message. + ERROR (2): + Error log message. + """ + INFO = 0 + WARNING = 1 + ERROR = 2 + + id: str = proto.Field( + proto.STRING, + number=1, + ) + action: Action = proto.Field( + proto.ENUM, + number=13, + enum=Action, + ) + location: 'SourceLocation' = proto.Field( + proto.MESSAGE, + number=2, + message='SourceLocation', + ) + condition: str = proto.Field( + proto.STRING, + number=3, + ) + expressions: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=4, + ) + log_message_format: str = proto.Field( + proto.STRING, + number=14, + ) + log_level: LogLevel = proto.Field( + proto.ENUM, + number=15, + enum=LogLevel, + ) + is_final_state: bool = proto.Field( + proto.BOOL, + number=5, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=11, + message=timestamp_pb2.Timestamp, + ) + final_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=12, + message=timestamp_pb2.Timestamp, + ) + user_email: str = proto.Field( + proto.STRING, + number=16, + ) + status: 'StatusMessage' = proto.Field( + proto.MESSAGE, + number=10, + message='StatusMessage', + ) + stack_frames: MutableSequence['StackFrame'] = proto.RepeatedField( + proto.MESSAGE, + number=7, + message='StackFrame', + ) + evaluated_expressions: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=8, + message='Variable', + ) + variable_table: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=9, + message='Variable', + ) + labels: MutableMapping[str, str] = 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 (MutableSequence[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 (MutableSequence[google.devtools.source.v1.source_context_pb2.ExtendedSourceContext]): + References to the locations and revisions of + the source code used in the deployed + application. + labels (MutableMapping[str, str]): + A set of custom debuggee properties, + populated by the agent, to be displayed to the + user. + """ + + id: str = proto.Field( + proto.STRING, + number=1, + ) + project: str = proto.Field( + proto.STRING, + number=2, + ) + uniquifier: str = proto.Field( + proto.STRING, + number=3, + ) + description: str = proto.Field( + proto.STRING, + number=4, + ) + is_inactive: bool = proto.Field( + proto.BOOL, + number=5, + ) + agent_version: str = proto.Field( + proto.STRING, + number=6, + ) + is_disabled: bool = proto.Field( + proto.BOOL, + number=7, + ) + status: 'StatusMessage' = proto.Field( + proto.MESSAGE, + number=8, + message='StatusMessage', + ) + source_contexts: MutableSequence[source_context_pb2.SourceContext] = proto.RepeatedField( + proto.MESSAGE, + number=9, + message=source_context_pb2.SourceContext, + ) + ext_source_contexts: MutableSequence[source_context_pb2.ExtendedSourceContext] = proto.RepeatedField( + proto.MESSAGE, + number=13, + message=source_context_pb2.ExtendedSourceContext, + ) + labels: MutableMapping[str, str] = 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..b58e3bc --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py @@ -0,0 +1,313 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 typing import MutableMapping, MutableSequence + +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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_: data.Breakpoint = proto.Field( + proto.MESSAGE, + number=2, + message=data.Breakpoint, + ) + client_version: str = 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_: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_id: str = proto.Field( + proto.STRING, + number=2, + ) + client_version: str = 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_: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_id: str = proto.Field( + proto.STRING, + number=2, + ) + client_version: str = 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: data.Breakpoint.Action = proto.Field( + proto.ENUM, + number=1, + enum=data.Breakpoint.Action, + ) + + debuggee_id: str = proto.Field( + proto.STRING, + number=1, + ) + include_all_users: bool = proto.Field( + proto.BOOL, + number=2, + ) + include_inactive: bool = proto.Field( + proto.BOOL, + number=3, + ) + action: BreakpointActionValue = proto.Field( + proto.MESSAGE, + number=4, + message=BreakpointActionValue, + ) + strip_results: bool = proto.Field( + proto.BOOL, + number=5, + ) + wait_token: str = proto.Field( + proto.STRING, + number=6, + ) + client_version: str = proto.Field( + proto.STRING, + number=8, + ) + + +class ListBreakpointsResponse(proto.Message): + r"""Response for listing breakpoints. + + Attributes: + breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + next_wait_token: str = 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: str = proto.Field( + proto.STRING, + number=2, + ) + include_inactive: bool = proto.Field( + proto.BOOL, + number=3, + ) + client_version: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ListDebuggeesResponse(proto.Message): + r"""Response for listing debuggees. + + Attributes: + debuggees (MutableSequence[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: MutableSequence[data.Debuggee] = 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..574c5ae --- /dev/null +++ b/owl-bot-staging/v2/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +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..02ef930 --- /dev/null +++ b/owl-bot-staging/v2/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +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") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/debugger_v2/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +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=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + 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=DEFAULT_PYTHON_VERSION) +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", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py new file mode 100644 index 0000000..24f6ea0 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListActiveBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py new file mode 100644 index 0000000..67c27c7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListActiveBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py new file mode 100644 index 0000000..b0ac801 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDebuggee +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = await client.register_debuggee(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py new file mode 100644 index 0000000..99f6287 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDebuggee +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = client.register_debuggee(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py new file mode 100644 index 0000000..e74e3e7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateActiveBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py new file mode 100644 index 0000000..10a9948 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateActiveBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py new file mode 100644 index 0000000..b445c89 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + await client.delete_breakpoint(request=request) + + +# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py new file mode 100644 index 0000000..01599f2 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + client.delete_breakpoint(request=request) + + +# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py new file mode 100644 index 0000000..7074dcf --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.get_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py new file mode 100644 index 0000000..3f7ebd0 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.get_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py new file mode 100644 index 0000000..816dd2b --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py new file mode 100644 index 0000000..4f65108 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py new file mode 100644 index 0000000..fda422c --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListDebuggees +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_debuggees(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py new file mode 100644 index 0000000..246e83f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListDebuggees +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_debuggees(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py new file mode 100644 index 0000000..6267555 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.set_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py new file mode 100644 index 0000000..22b41d7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.set_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json new file mode 100644 index 0000000..ab6c88f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json @@ -0,0 +1,1369 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.devtools.clouddebugger.v2", + "version": "v2" + } + ], + "language": "PYTHON", + "name": "google-cloud-debugger-client", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.list_active_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "ListActiveBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", + "shortName": "list_active_breakpoints" + }, + "description": "Sample for ListActiveBreakpoints", + "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.list_active_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "ListActiveBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", + "shortName": "list_active_breakpoints" + }, + "description": "Sample for ListActiveBreakpoints", + "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.register_debuggee", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "RegisterDebuggee" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" + }, + { + "name": "debuggee", + "type": "google.cloud.debugger_v2.types.Debuggee" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", + "shortName": "register_debuggee" + }, + "description": "Sample for RegisterDebuggee", + "file": "clouddebugger_v2_generated_controller2_register_debuggee_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_register_debuggee_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.register_debuggee", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "RegisterDebuggee" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" + }, + { + "name": "debuggee", + "type": "google.cloud.debugger_v2.types.Debuggee" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", + "shortName": "register_debuggee" + }, + "description": "Sample for RegisterDebuggee", + "file": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.update_active_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "UpdateActiveBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", + "shortName": "update_active_breakpoint" + }, + "description": "Sample for UpdateActiveBreakpoint", + "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.update_active_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "UpdateActiveBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", + "shortName": "update_active_breakpoint" + }, + "description": "Sample for UpdateActiveBreakpoint", + "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.delete_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "DeleteBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_breakpoint" + }, + "description": "Sample for DeleteBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.delete_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "DeleteBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_breakpoint" + }, + "description": "Sample for DeleteBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.get_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "GetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", + "shortName": "get_breakpoint" + }, + "description": "Sample for GetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_async", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.get_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "GetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", + "shortName": "get_breakpoint" + }, + "description": "Sample for GetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", + "shortName": "list_breakpoints" + }, + "description": "Sample for ListBreakpoints", + "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.list_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", + "shortName": "list_breakpoints" + }, + "description": "Sample for ListBreakpoints", + "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_debuggees", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListDebuggees" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" + }, + { + "name": "project", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", + "shortName": "list_debuggees" + }, + "description": "Sample for ListDebuggees", + "file": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.list_debuggees", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListDebuggees" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" + }, + { + "name": "project", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", + "shortName": "list_debuggees" + }, + "description": "Sample for ListDebuggees", + "file": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.set_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "SetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", + "shortName": "set_breakpoint" + }, + "description": "Sample for SetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.set_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "SetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", + "shortName": "set_breakpoint" + }, + "description": "Sample for SetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py" + } + ] +} 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..9802c14 --- /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 2022 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..4295418 --- /dev/null +++ b/owl-bot-staging/v2/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-debugger-client' + + +description = "Google Cloud Debugger Client API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/debugger/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-debugger-client" + +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() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v2/testing/constraints-3.10.txt b/owl-bot-staging/v2/testing/constraints-3.10.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.11.txt b/owl-bot-staging/v2/testing/constraints-3.11.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.12.txt b/owl-bot-staging/v2/testing/constraints-3.12.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.7.txt b/owl-bot-staging/v2/testing/constraints-3.7.txt new file mode 100644 index 0000000..6c44adf --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v2/testing/constraints-3.8.txt b/owl-bot-staging/v2/testing/constraints-3.8.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.9.txt b/owl-bot-staging/v2/testing/constraints-3.9.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..5058381 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py @@ -0,0 +1,2551 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +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,transport_name", [ + (Controller2Client, "grpc"), + (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), +]) +def test_controller2_client_from_service_account_info(client_class, transport_name): + 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, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.Controller2GrpcTransport, "grpc"), + (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Controller2RestTransport, "rest"), +]) +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,transport_name", [ + (Controller2Client, "grpc"), + (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), +]) +def test_controller2_client_from_service_account_file(client_class, transport_name): + 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", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +def test_controller2_client_get_transport_class(): + transport = Controller2Client.get_transport_class() + available_transports = [ + transports.Controller2GrpcTransport, + transports.Controller2RestTransport, + ] + 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"), + (Controller2Client, transports.Controller2RestTransport, "rest"), +]) +@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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + 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=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@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"), + (Controller2Client, transports.Controller2RestTransport, "rest", "true"), + (Controller2Client, transports.Controller2RestTransport, "rest", "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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + +@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"), + (Controller2Client, transports.Controller2RestTransport, "rest"), +]) +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, + api_audience=None, + ) + +@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), + (Controller2Client, transports.Controller2RestTransport, "rest", None), +]) +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, + api_audience=None, + ) + +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, + api_audience=None, + ) + + +@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, + api_audience=None, + ) + + # 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_field_headers(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.ListActiveBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # 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: + call.return_value = controller.ListActiveBreakpointsResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_active_breakpoints_field_headers_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.ListActiveBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # 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: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.UpdateActiveBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint.id = 'id_value' + + # 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: + call.return_value = controller.UpdateActiveBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_active_breakpoint_field_headers_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.UpdateActiveBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint.id = 'id_value' + + # 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: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', + ) in kw['metadata'] + + +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'), + ) + + +@pytest.mark.parametrize("request_type", [ + controller.RegisterDebuggeeRequest, + dict, +]) +def test_register_debuggee_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.register_debuggee(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.RegisterDebuggeeResponse) + + +def test_register_debuggee_rest_required_fields(request_type=controller.RegisterDebuggeeRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.register_debuggee(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_register_debuggee_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.register_debuggee._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("debuggee", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_register_debuggee_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_register_debuggee") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_register_debuggee") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.RegisterDebuggeeRequest.pb(controller.RegisterDebuggeeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.RegisterDebuggeeResponse.to_json(controller.RegisterDebuggeeResponse()) + + request = controller.RegisterDebuggeeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.RegisterDebuggeeResponse() + + client.register_debuggee(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_register_debuggee_rest_bad_request(transport: str = 'rest', request_type=controller.RegisterDebuggeeRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.register_debuggee(request) + + +def test_register_debuggee_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + debuggee=data.Debuggee(id='id_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.register_debuggee(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/register" % client.transport._host, args[1]) + + +def test_register_debuggee_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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'), + ) + + +def test_register_debuggee_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + controller.ListActiveBreakpointsRequest, + dict, +]) +def test_list_active_breakpoints_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse( + next_wait_token='next_wait_token_value', + wait_expired=True, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_active_breakpoints(request) + + # 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_rest_required_fields(request_type=controller.ListActiveBreakpointsRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("success_on_timeout", "wait_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_active_breakpoints(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_active_breakpoints_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_active_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == (set(("successOnTimeout", "waitToken", )) & set(("debuggeeId", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_active_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_list_active_breakpoints") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_list_active_breakpoints") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.ListActiveBreakpointsRequest.pb(controller.ListActiveBreakpointsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.ListActiveBreakpointsResponse.to_json(controller.ListActiveBreakpointsResponse()) + + request = controller.ListActiveBreakpointsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.ListActiveBreakpointsResponse() + + client.list_active_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_active_breakpoints_rest_bad_request(transport: str = 'rest', request_type=controller.ListActiveBreakpointsRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_active_breakpoints(request) + + +def test_list_active_breakpoints_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_active_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) + + +def test_list_active_breakpoints_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_active_breakpoints_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + controller.UpdateActiveBreakpointRequest, + dict, +]) +def test_update_active_breakpoint_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_active_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.UpdateActiveBreakpointResponse) + + +def test_update_active_breakpoint_rest_required_fields(request_type=controller.UpdateActiveBreakpointRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "put", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_active_breakpoint(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_active_breakpoint_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_active_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("debuggeeId", "breakpoint", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_active_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_update_active_breakpoint") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_update_active_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.UpdateActiveBreakpointRequest.pb(controller.UpdateActiveBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.UpdateActiveBreakpointResponse.to_json(controller.UpdateActiveBreakpointResponse()) + + request = controller.UpdateActiveBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.UpdateActiveBreakpointResponse() + + client.update_active_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_active_breakpoint_rest_bad_request(transport: str = 'rest', request_type=controller.UpdateActiveBreakpointRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_active_breakpoint(request) + + +def test_update_active_breakpoint_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_active_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}" % client.transport._host, args[1]) + + +def test_update_active_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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'), + ) + + +def test_update_active_breakpoint_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +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, + transports.Controller2RestTransport, +]) +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() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = Controller2Client.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +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() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +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", + [ + transports.Controller2GrpcTransport, + transports.Controller2GrpcAsyncIOTransport, + transports.Controller2RestTransport, + ], +) +def test_controller2_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@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_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.Controller2RestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_controller2_host_no_port(transport_name): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_controller2_host_with_port(transport_name): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_controller2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Controller2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Controller2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.register_debuggee._session + session2 = client2.transport.register_debuggee._session + assert session1 != session2 + session1 = client1.transport.list_active_breakpoints._session + session2 = client2.transport.list_active_breakpoints._session + assert session1 != session2 + session1 = client1.transport.update_active_breakpoint._session + session2 = client2.transport.update_active_breakpoint._session + assert session1 != session2 +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 = { + "rest": "_session", + "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 = [ + 'rest', + '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, + api_audience=None, + ) 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..ad07b63 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py @@ -0,0 +1,3628 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +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,transport_name", [ + (Debugger2Client, "grpc"), + (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), +]) +def test_debugger2_client_from_service_account_info(client_class, transport_name): + 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, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.Debugger2GrpcTransport, "grpc"), + (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Debugger2RestTransport, "rest"), +]) +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,transport_name", [ + (Debugger2Client, "grpc"), + (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), +]) +def test_debugger2_client_from_service_account_file(client_class, transport_name): + 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", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +def test_debugger2_client_get_transport_class(): + transport = Debugger2Client.get_transport_class() + available_transports = [ + transports.Debugger2GrpcTransport, + transports.Debugger2RestTransport, + ] + 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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), +]) +@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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + 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=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "true"), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + +@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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), +]) +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, + api_audience=None, + ) + +@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), + (Debugger2Client, transports.Debugger2RestTransport, "rest", None), +]) +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, + api_audience=None, + ) + +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, + api_audience=None, + ) + + +@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, + api_audience=None, + ) + + # 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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.SetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + call.return_value = debugger.SetBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_set_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.SetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.GetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + call.return_value = debugger.GetBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.GetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.DeleteBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + call.return_value = None + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.DeleteBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.ListBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + call.return_value = debugger.ListBreakpointsResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_breakpoints_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.ListBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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', + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.SetBreakpointRequest, + dict, +]) +def test_set_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.set_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.SetBreakpointResponse) + + +def test_set_breakpoint_rest_required_fields(request_type=debugger.SetBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("breakpoint_", "client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.set_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_set_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.set_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("breakpoint", "clientVersion", )) & set(("debuggeeId", "breakpoint", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_set_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_set_breakpoint") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_set_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.SetBreakpointRequest.pb(debugger.SetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.SetBreakpointResponse.to_json(debugger.SetBreakpointResponse()) + + request = debugger.SetBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.SetBreakpointResponse() + + client.set_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_set_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.SetBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.set_breakpoint(request) + + +def test_set_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.set_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/set" % client.transport._host, args[1]) + + +def test_set_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_set_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.GetBreakpointRequest, + dict, +]) +def test_get_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.GetBreakpointResponse) + + +def test_get_breakpoint_rest_required_fields(request_type=debugger.GetBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["breakpointId"] = 'breakpoint_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == 'breakpoint_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_get_breakpoint") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_get_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.GetBreakpointRequest.pb(debugger.GetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.GetBreakpointResponse.to_json(debugger.GetBreakpointResponse()) + + request = debugger.GetBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.GetBreakpointResponse() + + client.get_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.GetBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_breakpoint(request) + + +def test_get_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) + + +def test_get_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_get_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.DeleteBreakpointRequest, + dict, +]) +def test_delete_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_breakpoint(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_breakpoint_rest_required_fields(request_type=debugger.DeleteBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["breakpointId"] = 'breakpoint_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == 'breakpoint_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_delete_breakpoint") as pre: + pre.assert_not_called() + pb_message = debugger.DeleteBreakpointRequest.pb(debugger.DeleteBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = debugger.DeleteBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_delete_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.DeleteBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_breakpoint(request) + + +def test_delete_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) + + +def test_delete_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_delete_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.ListBreakpointsRequest, + dict, +]) +def test_list_breakpoints_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse( + next_wait_token='next_wait_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_breakpoints(request) + + # 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_rest_required_fields(request_type=debugger.ListBreakpointsRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("action", "client_version", "include_all_users", "include_inactive", "strip_results", "wait_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_breakpoints(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_breakpoints_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == (set(("action", "clientVersion", "includeAllUsers", "includeInactive", "stripResults", "waitToken", )) & set(("debuggeeId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_list_breakpoints") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_breakpoints") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListBreakpointsRequest.pb(debugger.ListBreakpointsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListBreakpointsResponse.to_json(debugger.ListBreakpointsResponse()) + + request = debugger.ListBreakpointsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListBreakpointsResponse() + + client.list_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_breakpoints_rest_bad_request(transport: str = 'rest', request_type=debugger.ListBreakpointsRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_breakpoints(request) + + +def test_list_breakpoints_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) + + +def test_list_breakpoints_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_breakpoints_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.ListDebuggeesRequest, + dict, +]) +def test_list_debuggees_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_debuggees(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.ListDebuggeesResponse) + + +def test_list_debuggees_rest_required_fields(request_type=debugger.ListDebuggeesRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["project"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "project" not in jsonified_request + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "project" in jsonified_request + assert jsonified_request["project"] == request_init["project"] + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["project"] = 'project_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", "include_inactive", "project", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "project" in jsonified_request + assert jsonified_request["project"] == 'project_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_debuggees(request) + + expected_params = [ + ( + "project", + "", + ), + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_debuggees_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_debuggees._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", "includeInactive", "project", )) & set(("project", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_debuggees_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_list_debuggees") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_debuggees") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListDebuggeesRequest.pb(debugger.ListDebuggeesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListDebuggeesResponse.to_json(debugger.ListDebuggeesResponse()) + + request = debugger.ListDebuggeesRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListDebuggeesResponse() + + client.list_debuggees(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_debuggees_rest_bad_request(transport: str = 'rest', request_type=debugger.ListDebuggeesRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_debuggees(request) + + +def test_list_debuggees_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + project='project_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_debuggees(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees" % client.transport._host, args[1]) + + +def test_list_debuggees_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_debuggees_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +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, + transports.Debugger2RestTransport, +]) +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() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = Debugger2Client.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +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() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +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", + [ + transports.Debugger2GrpcTransport, + transports.Debugger2GrpcAsyncIOTransport, + transports.Debugger2RestTransport, + ], +) +def test_debugger2_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@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_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.Debugger2RestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_debugger2_host_no_port(transport_name): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_debugger2_host_with_port(transport_name): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_debugger2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Debugger2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Debugger2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.set_breakpoint._session + session2 = client2.transport.set_breakpoint._session + assert session1 != session2 + session1 = client1.transport.get_breakpoint._session + session2 = client2.transport.get_breakpoint._session + assert session1 != session2 + session1 = client1.transport.delete_breakpoint._session + session2 = client2.transport.delete_breakpoint._session + assert session1 != session2 + session1 = client1.transport.list_breakpoints._session + session2 = client2.transport.list_breakpoints._session + assert session1 != session2 + session1 = client1.transport.list_debuggees._session + session2 = client2.transport.list_debuggees._session + assert session1 != session2 +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 = { + "rest": "_session", + "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 = [ + 'rest', + '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, + api_audience=None, + ) From c6c321f438f2a6a342631d57eb18a5ae7ee69334 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 8 Feb 2023 22:46:36 +0000 Subject: [PATCH 02/10] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20?= =?UTF-8?q?post-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- google/cloud/debugger_v2/gapic_metadata.json | 50 + .../services/controller2/client.py | 2 + .../controller2/transports/__init__.py | 4 + .../services/controller2/transports/rest.py | 320 +- .../debugger_v2/services/debugger2/client.py | 2 + .../services/debugger2/transports/__init__.py | 4 + .../services/debugger2/transports/rest.py | 456 ++- owl-bot-staging/v2/.coveragerc | 13 - owl-bot-staging/v2/.flake8 | 33 - 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 | 6 - owl-bot-staging/v2/docs/index.rst | 7 - .../v2/google/cloud/debugger/__init__.py | 75 - .../v2/google/cloud/debugger/gapic_version.py | 16 - .../v2/google/cloud/debugger/py.typed | 2 - .../v2/google/cloud/debugger_v2/__init__.py | 76 - .../cloud/debugger_v2/gapic_metadata.json | 167 - .../google/cloud/debugger_v2/gapic_version.py | 16 - .../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 | 566 --- .../services/controller2/client.py | 747 ---- .../controller2/transports/__init__.py | 38 - .../services/controller2/transports/base.py | 191 - .../services/controller2/transports/grpc.py | 369 -- .../controller2/transports/grpc_asyncio.py | 368 -- .../services/debugger2/__init__.py | 22 - .../services/debugger2/async_client.py | 806 ---- .../debugger_v2/services/debugger2/client.py | 973 ----- .../services/debugger2/transports/__init__.py | 38 - .../services/debugger2/transports/base.py | 234 -- .../services/debugger2/transports/grpc.py | 381 -- .../debugger2/transports/grpc_asyncio.py | 380 -- .../cloud/debugger_v2/types/__init__.py | 68 - .../cloud/debugger_v2/types/controller.py | 174 - .../v2/google/cloud/debugger_v2/types/data.py | 679 --- .../cloud/debugger_v2/types/debugger.py | 313 -- owl-bot-staging/v2/mypy.ini | 3 - owl-bot-staging/v2/noxfile.py | 184 - ...ntroller2_list_active_breakpoints_async.py | 52 - ...ontroller2_list_active_breakpoints_sync.py | 52 - ...ted_controller2_register_debuggee_async.py | 51 - ...ated_controller2_register_debuggee_sync.py | 51 - ...troller2_update_active_breakpoint_async.py | 52 - ...ntroller2_update_active_breakpoint_sync.py | 52 - ...rated_debugger2_delete_breakpoint_async.py | 52 - ...erated_debugger2_delete_breakpoint_sync.py | 52 - ...enerated_debugger2_get_breakpoint_async.py | 54 - ...generated_debugger2_get_breakpoint_sync.py | 54 - ...erated_debugger2_list_breakpoints_async.py | 53 - ...nerated_debugger2_list_breakpoints_sync.py | 53 - ...enerated_debugger2_list_debuggees_async.py | 53 - ...generated_debugger2_list_debuggees_sync.py | 53 - ...enerated_debugger2_set_breakpoint_async.py | 53 - ...generated_debugger2_set_breakpoint_sync.py | 53 - ...data_google.devtools.clouddebugger.v2.json | 1369 ------- .../v2/scripts/fixup_debugger_v2_keywords.py | 183 - owl-bot-staging/v2/setup.py | 90 - .../v2/testing/constraints-3.10.txt | 6 - .../v2/testing/constraints-3.11.txt | 6 - .../v2/testing/constraints-3.12.txt | 6 - .../v2/testing/constraints-3.7.txt | 9 - .../v2/testing/constraints-3.8.txt | 6 - .../v2/testing/constraints-3.9.txt | 6 - 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 | 2551 ------------ .../unit/gapic/debugger_v2/test_debugger2.py | 3628 ----------------- .../gapic/debugger_v2/test_controller2.py | 904 +++- .../unit/gapic/debugger_v2/test_debugger2.py | 1920 ++++++++- 78 files changed, 3209 insertions(+), 16647 deletions(-) rename {owl-bot-staging/v2/google => google}/cloud/debugger_v2/services/controller2/transports/rest.py (72%) rename {owl-bot-staging/v2/google => google}/cloud/debugger_v2/services/debugger2/transports/rest.py (69%) delete mode 100644 owl-bot-staging/v2/.coveragerc delete mode 100644 owl-bot-staging/v2/.flake8 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/gapic_version.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/gapic_version.py 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/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json 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/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.9.txt 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/gapic_metadata.json b/google/cloud/debugger_v2/gapic_metadata.json index fce739c..f0d8a90 100644 --- a/google/cloud/debugger_v2/gapic_metadata.json +++ b/google/cloud/debugger_v2/gapic_metadata.json @@ -46,6 +46,26 @@ ] } } + }, + "rest": { + "libraryClient": "Controller2Client", + "rpcs": { + "ListActiveBreakpoints": { + "methods": [ + "list_active_breakpoints" + ] + }, + "RegisterDebuggee": { + "methods": [ + "register_debuggee" + ] + }, + "UpdateActiveBreakpoint": { + "methods": [ + "update_active_breakpoint" + ] + } + } } } }, @@ -110,6 +130,36 @@ ] } } + }, + "rest": { + "libraryClient": "Debugger2Client", + "rpcs": { + "DeleteBreakpoint": { + "methods": [ + "delete_breakpoint" + ] + }, + "GetBreakpoint": { + "methods": [ + "get_breakpoint" + ] + }, + "ListBreakpoints": { + "methods": [ + "list_breakpoints" + ] + }, + "ListDebuggees": { + "methods": [ + "list_debuggees" + ] + }, + "SetBreakpoint": { + "methods": [ + "set_breakpoint" + ] + } + } } } } diff --git a/google/cloud/debugger_v2/services/controller2/client.py b/google/cloud/debugger_v2/services/controller2/client.py index 1fcfd80..5bfcf46 100644 --- a/google/cloud/debugger_v2/services/controller2/client.py +++ b/google/cloud/debugger_v2/services/controller2/client.py @@ -51,6 +51,7 @@ from .transports.base import DEFAULT_CLIENT_INFO, Controller2Transport from .transports.grpc import Controller2GrpcTransport from .transports.grpc_asyncio import Controller2GrpcAsyncIOTransport +from .transports.rest import Controller2RestTransport class Controller2ClientMeta(type): @@ -64,6 +65,7 @@ class Controller2ClientMeta(type): _transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] _transport_registry["grpc"] = Controller2GrpcTransport _transport_registry["grpc_asyncio"] = Controller2GrpcAsyncIOTransport + _transport_registry["rest"] = Controller2RestTransport def get_transport_class( cls, diff --git a/google/cloud/debugger_v2/services/controller2/transports/__init__.py b/google/cloud/debugger_v2/services/controller2/transports/__init__.py index 437c215..5b7d44b 100644 --- a/google/cloud/debugger_v2/services/controller2/transports/__init__.py +++ b/google/cloud/debugger_v2/services/controller2/transports/__init__.py @@ -19,14 +19,18 @@ from .base import Controller2Transport from .grpc import Controller2GrpcTransport from .grpc_asyncio import Controller2GrpcAsyncIOTransport +from .rest import Controller2RestInterceptor, Controller2RestTransport # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] _transport_registry["grpc"] = Controller2GrpcTransport _transport_registry["grpc_asyncio"] = Controller2GrpcAsyncIOTransport +_transport_registry["rest"] = Controller2RestTransport __all__ = ( "Controller2Transport", "Controller2GrpcTransport", "Controller2GrpcAsyncIOTransport", + "Controller2RestTransport", + "Controller2RestInterceptor", ) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py b/google/cloud/debugger_v2/services/controller2/transports/rest.py similarity index 72% rename from owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py rename to google/cloud/debugger_v2/services/controller2/transports/rest.py index b0202db..cc3b1b0 100644 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py +++ b/google/cloud/debugger_v2/services/controller2/transports/rest.py @@ -14,24 +14,21 @@ # limitations under the License. # -from google.auth.transport.requests import AuthorizedSession # type: ignore +import dataclasses import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore +import re +from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, path_template, rest_helpers, rest_streaming from google.api_core import exceptions as core_exceptions from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore from google.protobuf import json_format +import grpc # type: ignore from requests import __version__ as requests_version -import dataclasses -import re -from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings try: OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] @@ -41,8 +38,8 @@ from google.cloud.debugger_v2.types import controller -from .base import Controller2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - +from .base import Controller2Transport +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, @@ -95,7 +92,12 @@ def post_update_active_breakpoint(self, response): """ - def pre_list_active_breakpoints(self, request: controller.ListActiveBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.ListActiveBreakpointsRequest, Sequence[Tuple[str, str]]]: + + def pre_list_active_breakpoints( + self, + request: controller.ListActiveBreakpointsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[controller.ListActiveBreakpointsRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for list_active_breakpoints Override in a subclass to manipulate the request or metadata @@ -103,7 +105,9 @@ def pre_list_active_breakpoints(self, request: controller.ListActiveBreakpointsR """ return request, metadata - def post_list_active_breakpoints(self, response: controller.ListActiveBreakpointsResponse) -> controller.ListActiveBreakpointsResponse: + def post_list_active_breakpoints( + self, response: controller.ListActiveBreakpointsResponse + ) -> controller.ListActiveBreakpointsResponse: """Post-rpc interceptor for list_active_breakpoints Override in a subclass to manipulate the response @@ -111,7 +115,12 @@ def post_list_active_breakpoints(self, response: controller.ListActiveBreakpoint it is returned to user code. """ return response - def pre_register_debuggee(self, request: controller.RegisterDebuggeeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.RegisterDebuggeeRequest, Sequence[Tuple[str, str]]]: + + def pre_register_debuggee( + self, + request: controller.RegisterDebuggeeRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[controller.RegisterDebuggeeRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for register_debuggee Override in a subclass to manipulate the request or metadata @@ -119,7 +128,9 @@ def pre_register_debuggee(self, request: controller.RegisterDebuggeeRequest, met """ return request, metadata - def post_register_debuggee(self, response: controller.RegisterDebuggeeResponse) -> controller.RegisterDebuggeeResponse: + def post_register_debuggee( + self, response: controller.RegisterDebuggeeResponse + ) -> controller.RegisterDebuggeeResponse: """Post-rpc interceptor for register_debuggee Override in a subclass to manipulate the response @@ -127,7 +138,12 @@ def post_register_debuggee(self, response: controller.RegisterDebuggeeResponse) it is returned to user code. """ return response - def pre_update_active_breakpoint(self, request: controller.UpdateActiveBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.UpdateActiveBreakpointRequest, Sequence[Tuple[str, str]]]: + + def pre_update_active_breakpoint( + self, + request: controller.UpdateActiveBreakpointRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[controller.UpdateActiveBreakpointRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for update_active_breakpoint Override in a subclass to manipulate the request or metadata @@ -135,7 +151,9 @@ def pre_update_active_breakpoint(self, request: controller.UpdateActiveBreakpoin """ return request, metadata - def post_update_active_breakpoint(self, response: controller.UpdateActiveBreakpointResponse) -> controller.UpdateActiveBreakpointResponse: + def post_update_active_breakpoint( + self, response: controller.UpdateActiveBreakpointResponse + ) -> controller.UpdateActiveBreakpointResponse: """Post-rpc interceptor for update_active_breakpoint Override in a subclass to manipulate the response @@ -186,20 +204,21 @@ class Controller2RestTransport(Controller2Transport): """ - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[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, - url_scheme: str = 'https', - interceptor: Optional[Controller2RestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> None: + def __init__( + self, + *, + host: str = "clouddebugger.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[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, + url_scheme: str = "https", + interceptor: Optional[Controller2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: """Instantiate the transport. Args: @@ -238,7 +257,9 @@ def __init__(self, *, # credentials object maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER url_match_items = maybe_url_match.groupdict() @@ -249,10 +270,11 @@ def __init__(self, *, credentials=credentials, client_info=client_info, always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience + api_audience=api_audience, ) self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) + self._credentials, default_host=self.DEFAULT_HOST + ) if client_cert_source_for_mtls: self._session.configure_mtls_channel(client_cert_source_for_mtls) self._interceptor = interceptor or Controller2RestInterceptor() @@ -262,19 +284,24 @@ class _ListActiveBreakpoints(Controller2RestStub): def __hash__(self): return hash("ListActiveBreakpoints") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { - } + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} @classmethod def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.ListActiveBreakpointsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.ListActiveBreakpointsResponse: + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: controller.ListActiveBreakpointsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> controller.ListActiveBreakpointsResponse: r"""Call the list active breakpoints method over HTTP. Args: @@ -293,37 +320,42 @@ def __call__(self, """ - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints', - }, + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v2/controller/debuggees/{debuggee_id}/breakpoints", + }, ] - request, metadata = self._interceptor.pre_list_active_breakpoints(request, metadata) + request, metadata = self._interceptor.pre_list_active_breakpoints( + request, metadata + ) pb_request = controller.ListActiveBreakpointsRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) - uri = transcoded_request['uri'] - method = transcoded_request['method'] + uri = transcoded_request["uri"] + method = transcoded_request["method"] # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) - headers['Content-Type'] = 'application/json' + headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), - ) + ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. @@ -342,19 +374,24 @@ class _RegisterDebuggee(Controller2RestStub): def __hash__(self): return hash("RegisterDebuggee") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { - } + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} @classmethod def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.RegisterDebuggeeRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.RegisterDebuggeeResponse: + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: controller.RegisterDebuggeeRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> controller.RegisterDebuggeeResponse: r"""Call the register debuggee method over HTTP. Args: @@ -371,46 +408,51 @@ def __call__(self, Response for registering a debuggee. """ - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v2/controller/debuggees/register', - 'body': '*', - }, + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v2/controller/debuggees/register", + "body": "*", + }, ] - request, metadata = self._interceptor.pre_register_debuggee(request, metadata) + request, metadata = self._interceptor.pre_register_debuggee( + request, metadata + ) pb_request = controller.RegisterDebuggeeRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) # Jsonify the request body body = json_format.MessageToJson( - transcoded_request['body'], + transcoded_request["body"], including_default_value_fields=False, - use_integers_for_enums=True + use_integers_for_enums=True, ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] + uri = transcoded_request["uri"] + method = transcoded_request["method"] # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) - headers['Content-Type'] = 'application/json' + headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, - ) + ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. @@ -429,19 +471,24 @@ class _UpdateActiveBreakpoint(Controller2RestStub): def __hash__(self): return hash("UpdateActiveBreakpoint") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { - } + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} @classmethod def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.UpdateActiveBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.UpdateActiveBreakpointResponse: + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: controller.UpdateActiveBreakpointRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> controller.UpdateActiveBreakpointResponse: r"""Call the update active breakpoint method over HTTP. Args: @@ -463,46 +510,51 @@ def __call__(self, """ - http_options: List[Dict[str, str]] = [{ - 'method': 'put', - 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}', - 'body': '*', - }, + http_options: List[Dict[str, str]] = [ + { + "method": "put", + "uri": "/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}", + "body": "*", + }, ] - request, metadata = self._interceptor.pre_update_active_breakpoint(request, metadata) + request, metadata = self._interceptor.pre_update_active_breakpoint( + request, metadata + ) pb_request = controller.UpdateActiveBreakpointRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) # Jsonify the request body body = json_format.MessageToJson( - transcoded_request['body'], + transcoded_request["body"], including_default_value_fields=False, - use_integers_for_enums=True + use_integers_for_enums=True, ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] + uri = transcoded_request["uri"] + method = transcoded_request["method"] # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) - headers['Content-Type'] = 'application/json' + headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, - ) + ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. @@ -518,28 +570,36 @@ def __call__(self, return resp @property - def list_active_breakpoints(self) -> Callable[ - [controller.ListActiveBreakpointsRequest], - controller.ListActiveBreakpointsResponse]: + def list_active_breakpoints( + self, + ) -> Callable[ + [controller.ListActiveBreakpointsRequest], + controller.ListActiveBreakpointsResponse, + ]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast - return self._ListActiveBreakpoints(self._session, self._host, self._interceptor) # type: ignore + return self._ListActiveBreakpoints(self._session, self._host, self._interceptor) # type: ignore @property - def register_debuggee(self) -> Callable[ - [controller.RegisterDebuggeeRequest], - controller.RegisterDebuggeeResponse]: + def register_debuggee( + self, + ) -> Callable[ + [controller.RegisterDebuggeeRequest], controller.RegisterDebuggeeResponse + ]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast - return self._RegisterDebuggee(self._session, self._host, self._interceptor) # type: ignore + return self._RegisterDebuggee(self._session, self._host, self._interceptor) # type: ignore @property - def update_active_breakpoint(self) -> Callable[ - [controller.UpdateActiveBreakpointRequest], - controller.UpdateActiveBreakpointResponse]: + def update_active_breakpoint( + self, + ) -> Callable[ + [controller.UpdateActiveBreakpointRequest], + controller.UpdateActiveBreakpointResponse, + ]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast - return self._UpdateActiveBreakpoint(self._session, self._host, self._interceptor) # type: ignore + return self._UpdateActiveBreakpoint(self._session, self._host, self._interceptor) # type: ignore @property def kind(self) -> str: @@ -549,6 +609,4 @@ def close(self): self._session.close() -__all__=( - 'Controller2RestTransport', -) +__all__ = ("Controller2RestTransport",) diff --git a/google/cloud/debugger_v2/services/debugger2/client.py b/google/cloud/debugger_v2/services/debugger2/client.py index b220ba8..b4a1c66 100644 --- a/google/cloud/debugger_v2/services/debugger2/client.py +++ b/google/cloud/debugger_v2/services/debugger2/client.py @@ -51,6 +51,7 @@ from .transports.base import DEFAULT_CLIENT_INFO, Debugger2Transport from .transports.grpc import Debugger2GrpcTransport from .transports.grpc_asyncio import Debugger2GrpcAsyncIOTransport +from .transports.rest import Debugger2RestTransport class Debugger2ClientMeta(type): @@ -64,6 +65,7 @@ class Debugger2ClientMeta(type): _transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] _transport_registry["grpc"] = Debugger2GrpcTransport _transport_registry["grpc_asyncio"] = Debugger2GrpcAsyncIOTransport + _transport_registry["rest"] = Debugger2RestTransport def get_transport_class( cls, diff --git a/google/cloud/debugger_v2/services/debugger2/transports/__init__.py b/google/cloud/debugger_v2/services/debugger2/transports/__init__.py index 2668575..7506d8f 100644 --- a/google/cloud/debugger_v2/services/debugger2/transports/__init__.py +++ b/google/cloud/debugger_v2/services/debugger2/transports/__init__.py @@ -19,14 +19,18 @@ from .base import Debugger2Transport from .grpc import Debugger2GrpcTransport from .grpc_asyncio import Debugger2GrpcAsyncIOTransport +from .rest import Debugger2RestInterceptor, Debugger2RestTransport # Compile a registry of transports. _transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] _transport_registry["grpc"] = Debugger2GrpcTransport _transport_registry["grpc_asyncio"] = Debugger2GrpcAsyncIOTransport +_transport_registry["rest"] = Debugger2RestTransport __all__ = ( "Debugger2Transport", "Debugger2GrpcTransport", "Debugger2GrpcAsyncIOTransport", + "Debugger2RestTransport", + "Debugger2RestInterceptor", ) diff --git a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py b/google/cloud/debugger_v2/services/debugger2/transports/rest.py similarity index 69% rename from owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py rename to google/cloud/debugger_v2/services/debugger2/transports/rest.py index 8ae4962..3347e07 100644 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py +++ b/google/cloud/debugger_v2/services/debugger2/transports/rest.py @@ -14,24 +14,21 @@ # limitations under the License. # -from google.auth.transport.requests import AuthorizedSession # type: ignore +import dataclasses import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore +import re +from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +from google.api_core import gapic_v1, path_template, rest_helpers, rest_streaming from google.api_core import exceptions as core_exceptions from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - +from google.auth import credentials as ga_credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth.transport.requests import AuthorizedSession # type: ignore from google.protobuf import json_format +import grpc # type: ignore from requests import __version__ as requests_version -import dataclasses -import re -from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings try: OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault] @@ -39,11 +36,12 @@ OptionalRetry = Union[retries.Retry, object] # 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 as BASE_DEFAULT_CLIENT_INFO +from google.cloud.debugger_v2.types import debugger +from .base import DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO +from .base import Debugger2Transport DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, @@ -108,7 +106,12 @@ def post_set_breakpoint(self, response): """ - def pre_delete_breakpoint(self, request: debugger.DeleteBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.DeleteBreakpointRequest, Sequence[Tuple[str, str]]]: + + def pre_delete_breakpoint( + self, + request: debugger.DeleteBreakpointRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[debugger.DeleteBreakpointRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for delete_breakpoint Override in a subclass to manipulate the request or metadata @@ -116,7 +119,11 @@ def pre_delete_breakpoint(self, request: debugger.DeleteBreakpointRequest, metad """ return request, metadata - def pre_get_breakpoint(self, request: debugger.GetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.GetBreakpointRequest, Sequence[Tuple[str, str]]]: + def pre_get_breakpoint( + self, + request: debugger.GetBreakpointRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[debugger.GetBreakpointRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for get_breakpoint Override in a subclass to manipulate the request or metadata @@ -124,7 +131,9 @@ def pre_get_breakpoint(self, request: debugger.GetBreakpointRequest, metadata: S """ return request, metadata - def post_get_breakpoint(self, response: debugger.GetBreakpointResponse) -> debugger.GetBreakpointResponse: + def post_get_breakpoint( + self, response: debugger.GetBreakpointResponse + ) -> debugger.GetBreakpointResponse: """Post-rpc interceptor for get_breakpoint Override in a subclass to manipulate the response @@ -132,7 +141,12 @@ def post_get_breakpoint(self, response: debugger.GetBreakpointResponse) -> debug it is returned to user code. """ return response - def pre_list_breakpoints(self, request: debugger.ListBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListBreakpointsRequest, Sequence[Tuple[str, str]]]: + + def pre_list_breakpoints( + self, + request: debugger.ListBreakpointsRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[debugger.ListBreakpointsRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for list_breakpoints Override in a subclass to manipulate the request or metadata @@ -140,7 +154,9 @@ def pre_list_breakpoints(self, request: debugger.ListBreakpointsRequest, metadat """ return request, metadata - def post_list_breakpoints(self, response: debugger.ListBreakpointsResponse) -> debugger.ListBreakpointsResponse: + def post_list_breakpoints( + self, response: debugger.ListBreakpointsResponse + ) -> debugger.ListBreakpointsResponse: """Post-rpc interceptor for list_breakpoints Override in a subclass to manipulate the response @@ -148,7 +164,12 @@ def post_list_breakpoints(self, response: debugger.ListBreakpointsResponse) -> d it is returned to user code. """ return response - def pre_list_debuggees(self, request: debugger.ListDebuggeesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListDebuggeesRequest, Sequence[Tuple[str, str]]]: + + def pre_list_debuggees( + self, + request: debugger.ListDebuggeesRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[debugger.ListDebuggeesRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for list_debuggees Override in a subclass to manipulate the request or metadata @@ -156,7 +177,9 @@ def pre_list_debuggees(self, request: debugger.ListDebuggeesRequest, metadata: S """ return request, metadata - def post_list_debuggees(self, response: debugger.ListDebuggeesResponse) -> debugger.ListDebuggeesResponse: + def post_list_debuggees( + self, response: debugger.ListDebuggeesResponse + ) -> debugger.ListDebuggeesResponse: """Post-rpc interceptor for list_debuggees Override in a subclass to manipulate the response @@ -164,7 +187,12 @@ def post_list_debuggees(self, response: debugger.ListDebuggeesResponse) -> debug it is returned to user code. """ return response - def pre_set_breakpoint(self, request: debugger.SetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.SetBreakpointRequest, Sequence[Tuple[str, str]]]: + + def pre_set_breakpoint( + self, + request: debugger.SetBreakpointRequest, + metadata: Sequence[Tuple[str, str]], + ) -> Tuple[debugger.SetBreakpointRequest, Sequence[Tuple[str, str]]]: """Pre-rpc interceptor for set_breakpoint Override in a subclass to manipulate the request or metadata @@ -172,7 +200,9 @@ def pre_set_breakpoint(self, request: debugger.SetBreakpointRequest, metadata: S """ return request, metadata - def post_set_breakpoint(self, response: debugger.SetBreakpointResponse) -> debugger.SetBreakpointResponse: + def post_set_breakpoint( + self, response: debugger.SetBreakpointResponse + ) -> debugger.SetBreakpointResponse: """Post-rpc interceptor for set_breakpoint Override in a subclass to manipulate the response @@ -214,20 +244,21 @@ class Debugger2RestTransport(Debugger2Transport): """ - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[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, - url_scheme: str = 'https', - interceptor: Optional[Debugger2RestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> None: + def __init__( + self, + *, + host: str = "clouddebugger.googleapis.com", + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[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, + url_scheme: str = "https", + interceptor: Optional[Debugger2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: """Instantiate the transport. Args: @@ -266,7 +297,9 @@ def __init__(self, *, # credentials object maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + raise ValueError( + f"Unexpected hostname structure: {host}" + ) # pragma: NO COVER url_match_items = maybe_url_match.groupdict() @@ -277,10 +310,11 @@ def __init__(self, *, credentials=credentials, client_info=client_info, always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience + api_audience=api_audience, ) self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) + self._credentials, default_host=self.DEFAULT_HOST + ) if client_cert_source_for_mtls: self._session.configure_mtls_channel(client_cert_source_for_mtls) self._interceptor = interceptor or Debugger2RestInterceptor() @@ -290,19 +324,26 @@ class _DeleteBreakpoint(Debugger2RestStub): def __hash__(self): return hash("DeleteBreakpoint") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { - "clientVersion" : "", } + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "clientVersion": "", + } @classmethod def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.DeleteBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ): + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: debugger.DeleteBreakpointRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ): r"""Call the delete breakpoint method over HTTP. Args: @@ -315,37 +356,42 @@ def __call__(self, sent along with the request as metadata. """ - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', - }, + http_options: List[Dict[str, str]] = [ + { + "method": "delete", + "uri": "/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}", + }, ] - request, metadata = self._interceptor.pre_delete_breakpoint(request, metadata) + request, metadata = self._interceptor.pre_delete_breakpoint( + request, metadata + ) pb_request = debugger.DeleteBreakpointRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) - uri = transcoded_request['uri'] - method = transcoded_request['method'] + uri = transcoded_request["uri"] + method = transcoded_request["method"] # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) - headers['Content-Type'] = 'application/json' + headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), - ) + ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. @@ -356,19 +402,26 @@ class _GetBreakpoint(Debugger2RestStub): def __hash__(self): return hash("GetBreakpoint") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { - "clientVersion" : "", } + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "clientVersion": "", + } @classmethod def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.GetBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.GetBreakpointResponse: + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: debugger.GetBreakpointRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: r"""Call the get breakpoint method over HTTP. Args: @@ -389,37 +442,40 @@ def __call__(self, """ - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', - }, + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}", + }, ] request, metadata = self._interceptor.pre_get_breakpoint(request, metadata) pb_request = debugger.GetBreakpointRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) - uri = transcoded_request['uri'] - method = transcoded_request['method'] + uri = transcoded_request["uri"] + method = transcoded_request["method"] # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) - headers['Content-Type'] = 'application/json' + headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), - ) + ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. @@ -438,19 +494,26 @@ class _ListBreakpoints(Debugger2RestStub): def __hash__(self): return hash("ListBreakpoints") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { - "clientVersion" : "", } + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "clientVersion": "", + } @classmethod def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.ListBreakpointsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.ListBreakpointsResponse: + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: debugger.ListBreakpointsRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: r"""Call the list breakpoints method over HTTP. Args: @@ -467,37 +530,42 @@ def __call__(self, Response for listing breakpoints. """ - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints', - }, + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v2/debugger/debuggees/{debuggee_id}/breakpoints", + }, ] - request, metadata = self._interceptor.pre_list_breakpoints(request, metadata) + request, metadata = self._interceptor.pre_list_breakpoints( + request, metadata + ) pb_request = debugger.ListBreakpointsRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) - uri = transcoded_request['uri'] - method = transcoded_request['method'] + uri = transcoded_request["uri"] + method = transcoded_request["method"] # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) - headers['Content-Type'] = 'application/json' + headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), - ) + ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. @@ -516,19 +584,27 @@ class _ListDebuggees(Debugger2RestStub): def __hash__(self): return hash("ListDebuggees") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { - "project" : "", "clientVersion" : "", } + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "project": "", + "clientVersion": "", + } @classmethod def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.ListDebuggeesRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.ListDebuggeesResponse: + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: debugger.ListDebuggeesRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: r"""Call the list debuggees method over HTTP. Args: @@ -545,37 +621,40 @@ def __call__(self, Response for listing debuggees. """ - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees', - }, + http_options: List[Dict[str, str]] = [ + { + "method": "get", + "uri": "/v2/debugger/debuggees", + }, ] request, metadata = self._interceptor.pre_list_debuggees(request, metadata) pb_request = debugger.ListDebuggeesRequest.pb(request) transcoded_request = path_template.transcode(http_options, pb_request) - uri = transcoded_request['uri'] - method = transcoded_request['method'] + uri = transcoded_request["uri"] + method = transcoded_request["method"] # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) - headers['Content-Type'] = 'application/json' + headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), - ) + ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. @@ -594,19 +673,27 @@ class _SetBreakpoint(Debugger2RestStub): def __hash__(self): return hash("SetBreakpoint") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { - "breakpoint" : {}, "clientVersion" : "", } + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + "breakpoint": {}, + "clientVersion": "", + } @classmethod def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.SetBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.SetBreakpointResponse: + return { + k: v + for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() + if k not in message_dict + } + + def __call__( + self, + request: debugger.SetBreakpointRequest, + *, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Optional[float] = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: r"""Call the set breakpoint method over HTTP. Args: @@ -623,11 +710,12 @@ def __call__(self, Response for setting a breakpoint. """ - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/set', - 'body': 'breakpoint', - }, + http_options: List[Dict[str, str]] = [ + { + "method": "post", + "uri": "/v2/debugger/debuggees/{debuggee_id}/breakpoints/set", + "body": "breakpoint", + }, ] request, metadata = self._interceptor.pre_set_breakpoint(request, metadata) pb_request = debugger.SetBreakpointRequest.pb(request) @@ -636,33 +724,35 @@ def __call__(self, # Jsonify the request body body = json_format.MessageToJson( - transcoded_request['body'], + transcoded_request["body"], including_default_value_fields=False, - use_integers_for_enums=True + use_integers_for_enums=True, ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] + uri = transcoded_request["uri"] + method = transcoded_request["method"] # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) + query_params = json.loads( + json_format.MessageToJson( + transcoded_request["query_params"], + including_default_value_fields=False, + use_integers_for_enums=True, + ) + ) query_params.update(self._get_unset_required_fields(query_params)) query_params["$alt"] = "json;enum-encoding=int" # Send the request headers = dict(metadata) - headers['Content-Type'] = 'application/json' + headers["Content-Type"] = "application/json" response = getattr(self._session, method)( "{host}{uri}".format(host=self._host, uri=uri), timeout=timeout, headers=headers, params=rest_helpers.flatten_query_params(query_params, strict=True), data=body, - ) + ) # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception # subclass. @@ -678,44 +768,44 @@ def __call__(self, return resp @property - def delete_breakpoint(self) -> Callable[ - [debugger.DeleteBreakpointRequest], - empty_pb2.Empty]: + def delete_breakpoint( + self, + ) -> Callable[[debugger.DeleteBreakpointRequest], empty_pb2.Empty]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast - return self._DeleteBreakpoint(self._session, self._host, self._interceptor) # type: ignore + return self._DeleteBreakpoint(self._session, self._host, self._interceptor) # type: ignore @property - def get_breakpoint(self) -> Callable[ - [debugger.GetBreakpointRequest], - debugger.GetBreakpointResponse]: + def get_breakpoint( + self, + ) -> Callable[[debugger.GetBreakpointRequest], debugger.GetBreakpointResponse]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast - return self._GetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + return self._GetBreakpoint(self._session, self._host, self._interceptor) # type: ignore @property - def list_breakpoints(self) -> Callable[ - [debugger.ListBreakpointsRequest], - debugger.ListBreakpointsResponse]: + def list_breakpoints( + self, + ) -> Callable[[debugger.ListBreakpointsRequest], debugger.ListBreakpointsResponse]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast - return self._ListBreakpoints(self._session, self._host, self._interceptor) # type: ignore + return self._ListBreakpoints(self._session, self._host, self._interceptor) # type: ignore @property - def list_debuggees(self) -> Callable[ - [debugger.ListDebuggeesRequest], - debugger.ListDebuggeesResponse]: + def list_debuggees( + self, + ) -> Callable[[debugger.ListDebuggeesRequest], debugger.ListDebuggeesResponse]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast - return self._ListDebuggees(self._session, self._host, self._interceptor) # type: ignore + return self._ListDebuggees(self._session, self._host, self._interceptor) # type: ignore @property - def set_breakpoint(self) -> Callable[ - [debugger.SetBreakpointRequest], - debugger.SetBreakpointResponse]: + def set_breakpoint( + self, + ) -> Callable[[debugger.SetBreakpointRequest], debugger.SetBreakpointResponse]: # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. # In C++ this would require a dynamic_cast - return self._SetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + return self._SetBreakpoint(self._session, self._host, self._interceptor) # type: ignore @property def kind(self) -> str: @@ -725,6 +815,4 @@ def close(self): self._session.close() -__all__=( - 'Debugger2RestTransport', -) +__all__ = ("Debugger2RestTransport",) diff --git a/owl-bot-staging/v2/.coveragerc b/owl-bot-staging/v2/.coveragerc deleted file mode 100644 index 9620812..0000000 --- a/owl-bot-staging/v2/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/debugger/__init__.py - google/cloud/debugger/gapic_version.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ diff --git a/owl-bot-staging/v2/.flake8 b/owl-bot-staging/v2/.flake8 deleted file mode 100644 index 29227d4..0000000 --- a/owl-bot-staging/v2/.flake8 +++ /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 -# -# https://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. - -# Generated by synthtool. DO NOT EDIT! -[flake8] -ignore = E203, E266, E501, W503 -exclude = - # Exclude generated code. - **/proto/** - **/gapic/** - **/services/** - **/types/** - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py 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 4ad5ea1..0000000 --- a/owl-bot-staging/v2/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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"2022, 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 0106467..0000000 --- a/owl-bot-staging/v2/docs/debugger_v2/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Debugger v2 API -====================================== - -.. automodule:: google.cloud.debugger_v2.types - :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 1228468..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger/__init__.py +++ /dev/null @@ -1,75 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 import gapic_version as package_version - -__version__ = package_version.__version__ - - -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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -__version__ = "0.1.0" # {x-release-please-version} 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 c774017..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py +++ /dev/null @@ -1,76 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 import gapic_version as package_version - -__version__ = package_version.__version__ - - -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 f0d8a90..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json +++ /dev/null @@ -1,167 +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" - ] - } - } - }, - "rest": { - "libraryClient": "Controller2Client", - "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" - ] - } - } - }, - "rest": { - "libraryClient": "Debugger2Client", - "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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -__version__ = "0.1.0" # {x-release-please-version} 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 e8e1c38..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 e010a73..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 aa29878..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py +++ /dev/null @@ -1,566 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 variable 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: Optional[ga_credentials.Credentials] = None, - transport: Union[str, Controller2Transport] = "grpc_asyncio", - client_options: Optional[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: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, - *, - debuggee: Optional[data.Debuggee] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = await client.register_debuggee(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint.id", request.breakpoint.id), - )), - ) - - # 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() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 7330718..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py +++ /dev/null @@ -1,747 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 -from .transports.rest import Controller2RestTransport - - -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 - _transport_registry["rest"] = Controller2RestTransport - - def get_transport_class(cls, - label: Optional[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 variable 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: Optional[Union[str, Controller2Transport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() - client_options = cast(client_options_lib.ClientOptions, client_options) - - 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, - api_audience=client_options.api_audience, - ) - - def register_debuggee(self, - request: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, - *, - debuggee: Optional[data.Debuggee] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = client.register_debuggee(request=request) - - # Handle the response - print(response) - - 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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_active_breakpoint(self, - request: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint.id", request.breakpoint.id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "Controller2Client": - 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() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 0381ff4..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -from .rest import Controller2RestTransport -from .rest import Controller2RestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] -_transport_registry['grpc'] = Controller2GrpcTransport -_transport_registry['grpc_asyncio'] = Controller2GrpcAsyncIOTransport -_transport_registry['rest'] = Controller2RestTransport - -__all__ = ( - 'Controller2Transport', - 'Controller2GrpcTransport', - 'Controller2GrpcAsyncIOTransport', - 'Controller2RestTransport', - 'Controller2RestInterceptor', -) 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 8e480a6..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py +++ /dev/null @@ -1,191 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -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: Optional[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, - api_audience: Optional[str] = None, - **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. - """ - - 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) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # 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 - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - 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() - - @property - def kind(self) -> str: - 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 09e2efa..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py +++ /dev/null @@ -1,369 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[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() - - @property - def kind(self) -> str: - return "grpc" - - -__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 ae65db1..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py +++ /dev/null @@ -1,368 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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 5d7f609..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 257c378..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py +++ /dev/null @@ -1,806 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 variable 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: Optional[ga_credentials.Credentials] = None, - transport: Union[str, Debugger2Transport] = "grpc_asyncio", - client_options: Optional[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: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.SetBreakpointResponse: - r"""Sets the breakpoint to the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.set_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.GetBreakpointResponse: - r"""Gets breakpoint information. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.get_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # 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: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the breakpoint from the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - await client.delete_breakpoint(request=request) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def list_breakpoints(self, - request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListBreakpointsResponse: - r"""Lists all breakpoints for the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_breakpoints(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, - *, - project: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListDebuggeesResponse: - r"""Lists all the debuggees that the user has access to. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_debuggees(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 7e52f8d..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py +++ /dev/null @@ -1,973 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 -from .transports.rest import Debugger2RestTransport - - -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 - _transport_registry["rest"] = Debugger2RestTransport - - def get_transport_class(cls, - label: Optional[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 variable 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: Optional[Union[str, Debugger2Transport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() - client_options = cast(client_options_lib.ClientOptions, client_options) - - 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, - api_audience=client_options.api_audience, - ) - - def set_breakpoint(self, - request: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.SetBreakpointResponse: - r"""Sets the breakpoint to the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.set_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_breakpoint(self, - request: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.GetBreakpointResponse: - r"""Gets breakpoint information. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.get_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_breakpoint(self, - request: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the breakpoint from the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - client.delete_breakpoint(request=request) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def list_breakpoints(self, - request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListBreakpointsResponse: - r"""Lists all breakpoints for the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_breakpoints(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_debuggees(self, - request: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, - *, - project: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListDebuggeesResponse: - r"""Lists all the debuggees that the user has access to. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_debuggees(request=request) - - # Handle the response - print(response) - - 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) -> "Debugger2Client": - 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() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 cd9dd46..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -from .rest import Debugger2RestTransport -from .rest import Debugger2RestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] -_transport_registry['grpc'] = Debugger2GrpcTransport -_transport_registry['grpc_asyncio'] = Debugger2GrpcAsyncIOTransport -_transport_registry['rest'] = Debugger2RestTransport - -__all__ = ( - 'Debugger2Transport', - 'Debugger2GrpcTransport', - 'Debugger2GrpcAsyncIOTransport', - 'Debugger2RestTransport', - 'Debugger2RestInterceptor', -) 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 c4afc0c..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py +++ /dev/null @@ -1,234 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -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: Optional[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, - api_audience: Optional[str] = None, - **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. - """ - - 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) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # 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 - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - 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() - - @property - def kind(self) -> str: - 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 fbb3374..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py +++ /dev/null @@ -1,381 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[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() - - @property - def kind(self) -> str: - return "grpc" - - -__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 eb6eadc..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py +++ /dev/null @@ -1,380 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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 9791b6c..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py +++ /dev/null @@ -1,68 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 9001c20..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py +++ /dev/null @@ -1,174 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 typing import MutableMapping, MutableSequence - -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: data.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: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - wait_token: str = proto.Field( - proto.STRING, - number=2, - ) - success_on_timeout: bool = proto.Field( - proto.BOOL, - number=3, - ) - - -class ListActiveBreakpointsResponse(proto.Message): - r"""Response for listing active breakpoints. - - Attributes: - breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - next_wait_token: str = proto.Field( - proto.STRING, - number=2, - ) - wait_expired: bool = 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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_: data.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 4ab7f91..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py +++ /dev/null @@ -1,679 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 typing import MutableMapping, MutableSequence - -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 (MutableSequence[str]): - Optional parameters to be embedded into the - message. - """ - - format_: str = proto.Field( - proto.STRING, - number=1, - ) - parameters: MutableSequence[str] = 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. - - Values: - UNSPECIFIED (0): - Status doesn't refer to any particular input. - BREAKPOINT_SOURCE_LOCATION (3): - Status applies to the breakpoint and is - related to its location. - BREAKPOINT_CONDITION (4): - Status applies to the breakpoint and is - related to its condition. - BREAKPOINT_EXPRESSION (7): - Status applies to the breakpoint and is - related to its expressions. - BREAKPOINT_AGE (8): - Status applies to the breakpoint and is - related to its age. - VARIABLE_NAME (5): - Status applies to the entire variable. - VARIABLE_VALUE (6): - Status applies to variable value (variable - name is valid). - """ - UNSPECIFIED = 0 - BREAKPOINT_SOURCE_LOCATION = 3 - BREAKPOINT_CONDITION = 4 - BREAKPOINT_EXPRESSION = 7 - BREAKPOINT_AGE = 8 - VARIABLE_NAME = 5 - VARIABLE_VALUE = 6 - - is_error: bool = proto.Field( - proto.BOOL, - number=1, - ) - refers_to: Reference = proto.Field( - proto.ENUM, - number=2, - enum=Reference, - ) - description: 'FormatMessage' = 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: str = proto.Field( - proto.STRING, - number=1, - ) - line: int = proto.Field( - proto.INT32, - number=2, - ) - column: int = 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 (MutableSequence[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: str = proto.Field( - proto.STRING, - number=1, - ) - value: str = proto.Field( - proto.STRING, - number=2, - ) - type_: str = proto.Field( - proto.STRING, - number=6, - ) - members: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Variable', - ) - var_table_index: wrappers_pb2.Int32Value = proto.Field( - proto.MESSAGE, - number=4, - message=wrappers_pb2.Int32Value, - ) - status: 'StatusMessage' = 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 (MutableSequence[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_ (MutableSequence[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: str = proto.Field( - proto.STRING, - number=1, - ) - location: 'SourceLocation' = proto.Field( - proto.MESSAGE, - number=2, - message='SourceLocation', - ) - arguments: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Variable', - ) - locals_: MutableSequence['Variable'] = 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 (MutableSequence[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 (MutableSequence[google.cloud.debugger_v2.types.StackFrame]): - The stack at breakpoint time, where stack_frames[0] - represents the most recently entered function. - evaluated_expressions (MutableSequence[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 (MutableSequence[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 (MutableMapping[str, str]): - 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. - - Values: - CAPTURE (0): - Capture stack frame and variables and update - the breakpoint. The data is only captured once. - After that the breakpoint is set in a final - state. - LOG (1): - Log each breakpoint hit. The breakpoint - remains active until deleted or expired. - """ - CAPTURE = 0 - LOG = 1 - - class LogLevel(proto.Enum): - r"""Log severity levels. - - Values: - INFO (0): - Information log message. - WARNING (1): - Warning log message. - ERROR (2): - Error log message. - """ - INFO = 0 - WARNING = 1 - ERROR = 2 - - id: str = proto.Field( - proto.STRING, - number=1, - ) - action: Action = proto.Field( - proto.ENUM, - number=13, - enum=Action, - ) - location: 'SourceLocation' = proto.Field( - proto.MESSAGE, - number=2, - message='SourceLocation', - ) - condition: str = proto.Field( - proto.STRING, - number=3, - ) - expressions: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=4, - ) - log_message_format: str = proto.Field( - proto.STRING, - number=14, - ) - log_level: LogLevel = proto.Field( - proto.ENUM, - number=15, - enum=LogLevel, - ) - is_final_state: bool = proto.Field( - proto.BOOL, - number=5, - ) - create_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=11, - message=timestamp_pb2.Timestamp, - ) - final_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=12, - message=timestamp_pb2.Timestamp, - ) - user_email: str = proto.Field( - proto.STRING, - number=16, - ) - status: 'StatusMessage' = proto.Field( - proto.MESSAGE, - number=10, - message='StatusMessage', - ) - stack_frames: MutableSequence['StackFrame'] = proto.RepeatedField( - proto.MESSAGE, - number=7, - message='StackFrame', - ) - evaluated_expressions: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=8, - message='Variable', - ) - variable_table: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=9, - message='Variable', - ) - labels: MutableMapping[str, str] = 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 (MutableSequence[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 (MutableSequence[google.devtools.source.v1.source_context_pb2.ExtendedSourceContext]): - References to the locations and revisions of - the source code used in the deployed - application. - labels (MutableMapping[str, str]): - A set of custom debuggee properties, - populated by the agent, to be displayed to the - user. - """ - - id: str = proto.Field( - proto.STRING, - number=1, - ) - project: str = proto.Field( - proto.STRING, - number=2, - ) - uniquifier: str = proto.Field( - proto.STRING, - number=3, - ) - description: str = proto.Field( - proto.STRING, - number=4, - ) - is_inactive: bool = proto.Field( - proto.BOOL, - number=5, - ) - agent_version: str = proto.Field( - proto.STRING, - number=6, - ) - is_disabled: bool = proto.Field( - proto.BOOL, - number=7, - ) - status: 'StatusMessage' = proto.Field( - proto.MESSAGE, - number=8, - message='StatusMessage', - ) - source_contexts: MutableSequence[source_context_pb2.SourceContext] = proto.RepeatedField( - proto.MESSAGE, - number=9, - message=source_context_pb2.SourceContext, - ) - ext_source_contexts: MutableSequence[source_context_pb2.ExtendedSourceContext] = proto.RepeatedField( - proto.MESSAGE, - number=13, - message=source_context_pb2.ExtendedSourceContext, - ) - labels: MutableMapping[str, str] = 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 b58e3bc..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py +++ /dev/null @@ -1,313 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 typing import MutableMapping, MutableSequence - -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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_: data.Breakpoint = proto.Field( - proto.MESSAGE, - number=2, - message=data.Breakpoint, - ) - client_version: str = 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_: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_id: str = proto.Field( - proto.STRING, - number=2, - ) - client_version: str = 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_: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_id: str = proto.Field( - proto.STRING, - number=2, - ) - client_version: str = 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: data.Breakpoint.Action = proto.Field( - proto.ENUM, - number=1, - enum=data.Breakpoint.Action, - ) - - debuggee_id: str = proto.Field( - proto.STRING, - number=1, - ) - include_all_users: bool = proto.Field( - proto.BOOL, - number=2, - ) - include_inactive: bool = proto.Field( - proto.BOOL, - number=3, - ) - action: BreakpointActionValue = proto.Field( - proto.MESSAGE, - number=4, - message=BreakpointActionValue, - ) - strip_results: bool = proto.Field( - proto.BOOL, - number=5, - ) - wait_token: str = proto.Field( - proto.STRING, - number=6, - ) - client_version: str = proto.Field( - proto.STRING, - number=8, - ) - - -class ListBreakpointsResponse(proto.Message): - r"""Response for listing breakpoints. - - Attributes: - breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - next_wait_token: str = 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: str = proto.Field( - proto.STRING, - number=2, - ) - include_inactive: bool = proto.Field( - proto.BOOL, - number=3, - ) - client_version: str = proto.Field( - proto.STRING, - number=4, - ) - - -class ListDebuggeesResponse(proto.Message): - r"""Response for listing debuggees. - - Attributes: - debuggees (MutableSequence[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: MutableSequence[data.Debuggee] = 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 574c5ae..0000000 --- a/owl-bot-staging/v2/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/v2/noxfile.py b/owl-bot-staging/v2/noxfile.py deleted file mode 100644 index 02ef930..0000000 --- a/owl-bot-staging/v2/noxfile.py +++ /dev/null @@ -1,184 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", -] - -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") - -BLACK_VERSION = "black==22.3.0" -BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] -DEFAULT_PYTHON_VERSION = "3.11" - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", - "blacken", - "lint", - "lint_setup_py", -] - -@nox.session(python=ALL_PYTHON) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/debugger_v2/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -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=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - 'mypy', - 'types-requests', - 'types-protobuf' - ) - 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=DEFAULT_PYTHON_VERSION) -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", ""), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint(session): - """Run linters. - - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install("flake8", BLACK_VERSION) - session.run( - "black", - "--check", - *BLACK_PATHS, - ) - session.run("flake8", "google", "tests", "samples") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *BLACK_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py deleted file mode 100644 index 24f6ea0..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListActiveBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py deleted file mode 100644 index 67c27c7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListActiveBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py deleted file mode 100644 index b0ac801..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDebuggee -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = await client.register_debuggee(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py deleted file mode 100644 index 99f6287..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDebuggee -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = client.register_debuggee(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py deleted file mode 100644 index e74e3e7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateActiveBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py deleted file mode 100644 index 10a9948..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateActiveBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py deleted file mode 100644 index b445c89..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - await client.delete_breakpoint(request=request) - - -# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py deleted file mode 100644 index 01599f2..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - client.delete_breakpoint(request=request) - - -# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py deleted file mode 100644 index 7074dcf..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.get_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py deleted file mode 100644 index 3f7ebd0..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.get_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py deleted file mode 100644 index 816dd2b..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py deleted file mode 100644 index 4f65108..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py deleted file mode 100644 index fda422c..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListDebuggees -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_debuggees(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py deleted file mode 100644 index 246e83f..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListDebuggees -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_debuggees(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py deleted file mode 100644 index 6267555..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.set_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py deleted file mode 100644 index 22b41d7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.set_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json deleted file mode 100644 index ab6c88f..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json +++ /dev/null @@ -1,1369 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.devtools.clouddebugger.v2", - "version": "v2" - } - ], - "language": "PYTHON", - "name": "google-cloud-debugger-client", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.list_active_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "ListActiveBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", - "shortName": "list_active_breakpoints" - }, - "description": "Sample for ListActiveBreakpoints", - "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.list_active_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "ListActiveBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", - "shortName": "list_active_breakpoints" - }, - "description": "Sample for ListActiveBreakpoints", - "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.register_debuggee", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "RegisterDebuggee" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" - }, - { - "name": "debuggee", - "type": "google.cloud.debugger_v2.types.Debuggee" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", - "shortName": "register_debuggee" - }, - "description": "Sample for RegisterDebuggee", - "file": "clouddebugger_v2_generated_controller2_register_debuggee_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_async", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_register_debuggee_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.register_debuggee", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "RegisterDebuggee" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" - }, - { - "name": "debuggee", - "type": "google.cloud.debugger_v2.types.Debuggee" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", - "shortName": "register_debuggee" - }, - "description": "Sample for RegisterDebuggee", - "file": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.update_active_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "UpdateActiveBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", - "shortName": "update_active_breakpoint" - }, - "description": "Sample for UpdateActiveBreakpoint", - "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.update_active_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "UpdateActiveBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", - "shortName": "update_active_breakpoint" - }, - "description": "Sample for UpdateActiveBreakpoint", - "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.delete_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "DeleteBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_breakpoint" - }, - "description": "Sample for DeleteBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.delete_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "DeleteBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_breakpoint" - }, - "description": "Sample for DeleteBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.get_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "GetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", - "shortName": "get_breakpoint" - }, - "description": "Sample for GetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_async", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.get_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "GetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", - "shortName": "get_breakpoint" - }, - "description": "Sample for GetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", - "shortName": "list_breakpoints" - }, - "description": "Sample for ListBreakpoints", - "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.list_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", - "shortName": "list_breakpoints" - }, - "description": "Sample for ListBreakpoints", - "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_debuggees", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListDebuggees" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" - }, - { - "name": "project", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", - "shortName": "list_debuggees" - }, - "description": "Sample for ListDebuggees", - "file": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.list_debuggees", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListDebuggees" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" - }, - { - "name": "project", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", - "shortName": "list_debuggees" - }, - "description": "Sample for ListDebuggees", - "file": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.set_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "SetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", - "shortName": "set_breakpoint" - }, - "description": "Sample for SetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.set_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "SetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", - "shortName": "set_breakpoint" - }, - "description": "Sample for SetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py" - } - ] -} 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 9802c14..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 2022 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 4295418..0000000 --- a/owl-bot-staging/v2/setup.py +++ /dev/null @@ -1,90 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-cloud-debugger-client' - - -description = "Google Cloud Debugger Client API client library" - -version = {} -with open(os.path.join(package_root, 'google/cloud/debugger/gapic_version.py')) as fp: - exec(fp.read(), version) -version = version["__version__"] - -if version[0] == "0": - release_status = "Development Status :: 4 - Beta" -else: - release_status = "Development Status :: 5 - Production/Stable" - -dependencies = [ - "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - "proto-plus >= 1.22.0, <2.0.0dev", - "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", - "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", -] -url = "https://github.com/googleapis/python-debugger-client" - -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() - -packages = [ - package - for package in setuptools.PEP420PackageFinder.find() - if package.startswith("google") -] - -namespaces = ["google", "google.cloud"] - -setuptools.setup( - name=name, - version=version, - description=description, - long_description=readme, - author="Google LLC", - author_email="googleapis-packages@google.com", - license="Apache 2.0", - url=url, - classifiers=[ - release_status, - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - namespace_packages=namespaces, - install_requires=dependencies, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/v2/testing/constraints-3.10.txt b/owl-bot-staging/v2/testing/constraints-3.10.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.10.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.11.txt b/owl-bot-staging/v2/testing/constraints-3.11.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.11.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.12.txt b/owl-bot-staging/v2/testing/constraints-3.12.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.12.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.7.txt b/owl-bot-staging/v2/testing/constraints-3.7.txt deleted file mode 100644 index 6c44adf..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.7.txt +++ /dev/null @@ -1,9 +0,0 @@ -# This constraints file is used to check that lower bounds -# are correct in setup.py -# List all library dependencies and extras in this file. -# Pin the version to the lower bound. -# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.0 -proto-plus==1.22.0 -protobuf==3.19.5 diff --git a/owl-bot-staging/v2/testing/constraints-3.8.txt b/owl-bot-staging/v2/testing/constraints-3.8.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.8.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.9.txt b/owl-bot-staging/v2/testing/constraints-3.9.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.9.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v2/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 5058381..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py +++ /dev/null @@ -1,2551 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -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,transport_name", [ - (Controller2Client, "grpc"), - (Controller2AsyncClient, "grpc_asyncio"), - (Controller2Client, "rest"), -]) -def test_controller2_client_from_service_account_info(client_class, transport_name): - 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, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.Controller2GrpcTransport, "grpc"), - (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), - (transports.Controller2RestTransport, "rest"), -]) -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,transport_name", [ - (Controller2Client, "grpc"), - (Controller2AsyncClient, "grpc_asyncio"), - (Controller2Client, "rest"), -]) -def test_controller2_client_from_service_account_file(client_class, transport_name): - 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", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -def test_controller2_client_get_transport_class(): - transport = Controller2Client.get_transport_class() - available_transports = [ - transports.Controller2GrpcTransport, - transports.Controller2RestTransport, - ] - 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"), - (Controller2Client, transports.Controller2RestTransport, "rest"), -]) -@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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - 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=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@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"), - (Controller2Client, transports.Controller2RestTransport, "rest", "true"), - (Controller2Client, transports.Controller2RestTransport, "rest", "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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - -@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"), - (Controller2Client, transports.Controller2RestTransport, "rest"), -]) -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, - api_audience=None, - ) - -@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), - (Controller2Client, transports.Controller2RestTransport, "rest", None), -]) -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, - api_audience=None, - ) - -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, - api_audience=None, - ) - - -@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, - api_audience=None, - ) - - # 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_field_headers(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.ListActiveBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # 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: - call.return_value = controller.ListActiveBreakpointsResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_active_breakpoints_field_headers_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.ListActiveBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # 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: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.UpdateActiveBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint.id = 'id_value' - - # 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: - call.return_value = controller.UpdateActiveBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_active_breakpoint_field_headers_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.UpdateActiveBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint.id = 'id_value' - - # 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: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', - ) in kw['metadata'] - - -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'), - ) - - -@pytest.mark.parametrize("request_type", [ - controller.RegisterDebuggeeRequest, - dict, -]) -def test_register_debuggee_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.register_debuggee(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.RegisterDebuggeeResponse) - - -def test_register_debuggee_rest_required_fields(request_type=controller.RegisterDebuggeeRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.register_debuggee(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_register_debuggee_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.register_debuggee._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("debuggee", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_register_debuggee_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_register_debuggee") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_register_debuggee") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.RegisterDebuggeeRequest.pb(controller.RegisterDebuggeeRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.RegisterDebuggeeResponse.to_json(controller.RegisterDebuggeeResponse()) - - request = controller.RegisterDebuggeeRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.RegisterDebuggeeResponse() - - client.register_debuggee(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_register_debuggee_rest_bad_request(transport: str = 'rest', request_type=controller.RegisterDebuggeeRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.register_debuggee(request) - - -def test_register_debuggee_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {} - - # get truthy value for each flattened field - mock_args = dict( - debuggee=data.Debuggee(id='id_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.register_debuggee(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/register" % client.transport._host, args[1]) - - -def test_register_debuggee_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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'), - ) - - -def test_register_debuggee_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - controller.ListActiveBreakpointsRequest, - dict, -]) -def test_list_active_breakpoints_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse( - next_wait_token='next_wait_token_value', - wait_expired=True, - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_active_breakpoints(request) - - # 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_rest_required_fields(request_type=controller.ListActiveBreakpointsRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("success_on_timeout", "wait_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_active_breakpoints(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_active_breakpoints_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_active_breakpoints._get_unset_required_fields({}) - assert set(unset_fields) == (set(("successOnTimeout", "waitToken", )) & set(("debuggeeId", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_active_breakpoints_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_list_active_breakpoints") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_list_active_breakpoints") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.ListActiveBreakpointsRequest.pb(controller.ListActiveBreakpointsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.ListActiveBreakpointsResponse.to_json(controller.ListActiveBreakpointsResponse()) - - request = controller.ListActiveBreakpointsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.ListActiveBreakpointsResponse() - - client.list_active_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_active_breakpoints_rest_bad_request(transport: str = 'rest', request_type=controller.ListActiveBreakpointsRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_active_breakpoints(request) - - -def test_list_active_breakpoints_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_active_breakpoints(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) - - -def test_list_active_breakpoints_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_active_breakpoints_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - controller.UpdateActiveBreakpointRequest, - dict, -]) -def test_update_active_breakpoint_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.update_active_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.UpdateActiveBreakpointResponse) - - -def test_update_active_breakpoint_rest_required_fields(request_type=controller.UpdateActiveBreakpointRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "put", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.update_active_breakpoint(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_update_active_breakpoint_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.update_active_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("debuggeeId", "breakpoint", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_active_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_update_active_breakpoint") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_update_active_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.UpdateActiveBreakpointRequest.pb(controller.UpdateActiveBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.UpdateActiveBreakpointResponse.to_json(controller.UpdateActiveBreakpointResponse()) - - request = controller.UpdateActiveBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.UpdateActiveBreakpointResponse() - - client.update_active_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_update_active_breakpoint_rest_bad_request(transport: str = 'rest', request_type=controller.UpdateActiveBreakpointRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.update_active_breakpoint(request) - - -def test_update_active_breakpoint_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.update_active_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}" % client.transport._host, args[1]) - - -def test_update_active_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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'), - ) - - -def test_update_active_breakpoint_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -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, - transports.Controller2RestTransport, -]) -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() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = Controller2Client.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -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() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -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", - [ - transports.Controller2GrpcTransport, - transports.Controller2GrpcAsyncIOTransport, - transports.Controller2RestTransport, - ], -) -def test_controller2_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@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_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.Controller2RestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_controller2_host_no_port(transport_name): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_controller2_host_with_port(transport_name): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_controller2_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = Controller2Client( - credentials=creds1, - transport=transport_name, - ) - client2 = Controller2Client( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.register_debuggee._session - session2 = client2.transport.register_debuggee._session - assert session1 != session2 - session1 = client1.transport.list_active_breakpoints._session - session2 = client2.transport.list_active_breakpoints._session - assert session1 != session2 - session1 = client1.transport.update_active_breakpoint._session - session2 = client2.transport.update_active_breakpoint._session - assert session1 != session2 -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 = { - "rest": "_session", - "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 = [ - 'rest', - '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, - api_audience=None, - ) 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 ad07b63..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py +++ /dev/null @@ -1,3628 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -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,transport_name", [ - (Debugger2Client, "grpc"), - (Debugger2AsyncClient, "grpc_asyncio"), - (Debugger2Client, "rest"), -]) -def test_debugger2_client_from_service_account_info(client_class, transport_name): - 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, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.Debugger2GrpcTransport, "grpc"), - (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), - (transports.Debugger2RestTransport, "rest"), -]) -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,transport_name", [ - (Debugger2Client, "grpc"), - (Debugger2AsyncClient, "grpc_asyncio"), - (Debugger2Client, "rest"), -]) -def test_debugger2_client_from_service_account_file(client_class, transport_name): - 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", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -def test_debugger2_client_get_transport_class(): - transport = Debugger2Client.get_transport_class() - available_transports = [ - transports.Debugger2GrpcTransport, - transports.Debugger2RestTransport, - ] - 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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest"), -]) -@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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - 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=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest", "true"), - (Debugger2Client, transports.Debugger2RestTransport, "rest", "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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - -@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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest"), -]) -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, - api_audience=None, - ) - -@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), - (Debugger2Client, transports.Debugger2RestTransport, "rest", None), -]) -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, - api_audience=None, - ) - -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, - api_audience=None, - ) - - -@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, - api_audience=None, - ) - - # 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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.SetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - call.return_value = debugger.SetBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_set_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.SetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.GetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - call.return_value = debugger.GetBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.GetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.DeleteBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - call.return_value = None - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.DeleteBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.ListBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - call.return_value = debugger.ListBreakpointsResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_breakpoints_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.ListBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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', - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.SetBreakpointRequest, - dict, -]) -def test_set_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.set_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.SetBreakpointResponse) - - -def test_set_breakpoint_rest_required_fields(request_type=debugger.SetBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("breakpoint_", "client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.set_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_set_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.set_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("breakpoint", "clientVersion", )) & set(("debuggeeId", "breakpoint", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_set_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_set_breakpoint") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_set_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.SetBreakpointRequest.pb(debugger.SetBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.SetBreakpointResponse.to_json(debugger.SetBreakpointResponse()) - - request = debugger.SetBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.SetBreakpointResponse() - - client.set_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_set_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.SetBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.set_breakpoint(request) - - -def test_set_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.set_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/set" % client.transport._host, args[1]) - - -def test_set_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_set_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.GetBreakpointRequest, - dict, -]) -def test_get_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.get_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.GetBreakpointResponse) - - -def test_get_breakpoint_rest_required_fields(request_type=debugger.GetBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["breakpoint_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["breakpointId"] = 'breakpoint_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "breakpointId" in jsonified_request - assert jsonified_request["breakpointId"] == 'breakpoint_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.get_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_get_breakpoint") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_get_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.GetBreakpointRequest.pb(debugger.GetBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.GetBreakpointResponse.to_json(debugger.GetBreakpointResponse()) - - request = debugger.GetBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.GetBreakpointResponse() - - client.get_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.GetBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.get_breakpoint(request) - - -def test_get_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.get_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) - - -def test_get_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_get_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.DeleteBreakpointRequest, - dict, -]) -def test_delete_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.delete_breakpoint(request) - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_breakpoint_rest_required_fields(request_type=debugger.DeleteBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["breakpoint_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["breakpointId"] = 'breakpoint_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "breakpointId" in jsonified_request - assert jsonified_request["breakpointId"] == 'breakpoint_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = None - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "delete", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.delete_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_delete_breakpoint") as pre: - pre.assert_not_called() - pb_message = debugger.DeleteBreakpointRequest.pb(debugger.DeleteBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - - request = debugger.DeleteBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.delete_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_delete_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.DeleteBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.delete_breakpoint(request) - - -def test_delete_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.delete_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) - - -def test_delete_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_delete_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.ListBreakpointsRequest, - dict, -]) -def test_list_breakpoints_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse( - next_wait_token='next_wait_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_breakpoints(request) - - # 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_rest_required_fields(request_type=debugger.ListBreakpointsRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("action", "client_version", "include_all_users", "include_inactive", "strip_results", "wait_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_breakpoints(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_breakpoints_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_breakpoints._get_unset_required_fields({}) - assert set(unset_fields) == (set(("action", "clientVersion", "includeAllUsers", "includeInactive", "stripResults", "waitToken", )) & set(("debuggeeId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_breakpoints_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_list_breakpoints") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_breakpoints") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.ListBreakpointsRequest.pb(debugger.ListBreakpointsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.ListBreakpointsResponse.to_json(debugger.ListBreakpointsResponse()) - - request = debugger.ListBreakpointsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.ListBreakpointsResponse() - - client.list_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_breakpoints_rest_bad_request(transport: str = 'rest', request_type=debugger.ListBreakpointsRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_breakpoints(request) - - -def test_list_breakpoints_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_breakpoints(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) - - -def test_list_breakpoints_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_breakpoints_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.ListDebuggeesRequest, - dict, -]) -def test_list_debuggees_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_debuggees(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.ListDebuggeesResponse) - - -def test_list_debuggees_rest_required_fields(request_type=debugger.ListDebuggeesRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["project"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "project" not in jsonified_request - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "project" in jsonified_request - assert jsonified_request["project"] == request_init["project"] - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["project"] = 'project_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", "include_inactive", "project", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "project" in jsonified_request - assert jsonified_request["project"] == 'project_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_debuggees(request) - - expected_params = [ - ( - "project", - "", - ), - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_debuggees_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_debuggees._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", "includeInactive", "project", )) & set(("project", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_debuggees_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_list_debuggees") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_debuggees") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.ListDebuggeesRequest.pb(debugger.ListDebuggeesRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.ListDebuggeesResponse.to_json(debugger.ListDebuggeesResponse()) - - request = debugger.ListDebuggeesRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.ListDebuggeesResponse() - - client.list_debuggees(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_debuggees_rest_bad_request(transport: str = 'rest', request_type=debugger.ListDebuggeesRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_debuggees(request) - - -def test_list_debuggees_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {} - - # get truthy value for each flattened field - mock_args = dict( - project='project_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_debuggees(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees" % client.transport._host, args[1]) - - -def test_list_debuggees_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_debuggees_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -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, - transports.Debugger2RestTransport, -]) -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() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = Debugger2Client.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -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() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -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", - [ - transports.Debugger2GrpcTransport, - transports.Debugger2GrpcAsyncIOTransport, - transports.Debugger2RestTransport, - ], -) -def test_debugger2_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@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_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.Debugger2RestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_debugger2_host_no_port(transport_name): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_debugger2_host_with_port(transport_name): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_debugger2_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = Debugger2Client( - credentials=creds1, - transport=transport_name, - ) - client2 = Debugger2Client( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.set_breakpoint._session - session2 = client2.transport.set_breakpoint._session - assert session1 != session2 - session1 = client1.transport.get_breakpoint._session - session2 = client2.transport.get_breakpoint._session - assert session1 != session2 - session1 = client1.transport.delete_breakpoint._session - session2 = client2.transport.delete_breakpoint._session - assert session1 != session2 - session1 = client1.transport.list_breakpoints._session - session2 = client2.transport.list_breakpoints._session - assert session1 != session2 - session1 = client1.transport.list_debuggees._session - session2 = client2.transport.list_debuggees._session - assert session1 != session2 -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 = { - "rest": "_session", - "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 = [ - 'rest', - '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, - api_audience=None, - ) diff --git a/tests/unit/gapic/debugger_v2/test_controller2.py b/tests/unit/gapic/debugger_v2/test_controller2.py index 69aebc2..9a21e91 100644 --- a/tests/unit/gapic/debugger_v2/test_controller2.py +++ b/tests/unit/gapic/debugger_v2/test_controller2.py @@ -22,6 +22,8 @@ except ImportError: # pragma: NO COVER import mock +from collections.abc import Iterable +import json import math from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template @@ -34,6 +36,7 @@ source_context as source_context_pb2, ) # type: ignore from google.oauth2 import service_account +from google.protobuf import json_format from google.protobuf import timestamp_pb2 # type: ignore from google.protobuf import wrappers_pb2 # type: ignore import grpc @@ -41,6 +44,8 @@ from proto.marshal.rules import wrappers from proto.marshal.rules.dates import DurationRule, TimestampRule import pytest +from requests import PreparedRequest, Request, Response +from requests.sessions import Session from google.cloud.debugger_v2.services.controller2 import ( Controller2AsyncClient, @@ -96,6 +101,7 @@ def test__get_default_mtls_endpoint(): [ (Controller2Client, "grpc"), (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), ], ) def test_controller2_client_from_service_account_info(client_class, transport_name): @@ -109,7 +115,11 @@ def test_controller2_client_from_service_account_info(client_class, transport_na assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("clouddebugger.googleapis.com:443") + assert client.transport._host == ( + "clouddebugger.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com" + ) @pytest.mark.parametrize( @@ -117,6 +127,7 @@ def test_controller2_client_from_service_account_info(client_class, transport_na [ (transports.Controller2GrpcTransport, "grpc"), (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Controller2RestTransport, "rest"), ], ) def test_controller2_client_service_account_always_use_jwt( @@ -142,6 +153,7 @@ def test_controller2_client_service_account_always_use_jwt( [ (Controller2Client, "grpc"), (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), ], ) def test_controller2_client_from_service_account_file(client_class, transport_name): @@ -162,13 +174,18 @@ def test_controller2_client_from_service_account_file(client_class, transport_na assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("clouddebugger.googleapis.com:443") + assert client.transport._host == ( + "clouddebugger.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com" + ) def test_controller2_client_get_transport_class(): transport = Controller2Client.get_transport_class() available_transports = [ transports.Controller2GrpcTransport, + transports.Controller2RestTransport, ] assert transport in available_transports @@ -185,6 +202,7 @@ def test_controller2_client_get_transport_class(): transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", ), + (Controller2Client, transports.Controller2RestTransport, "rest"), ], ) @mock.patch.object( @@ -328,6 +346,8 @@ def test_controller2_client_client_options( "grpc_asyncio", "false", ), + (Controller2Client, transports.Controller2RestTransport, "rest", "true"), + (Controller2Client, transports.Controller2RestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -521,6 +541,7 @@ def test_controller2_client_get_mtls_endpoint_and_cert_source(client_class): transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio", ), + (Controller2Client, transports.Controller2RestTransport, "rest"), ], ) def test_controller2_client_client_options_scopes( @@ -556,6 +577,7 @@ def test_controller2_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (Controller2Client, transports.Controller2RestTransport, "rest", None), ], ) def test_controller2_client_client_options_credentials_file( @@ -1343,6 +1365,826 @@ async def test_update_active_breakpoint_flattened_error_async(): ) +@pytest.mark.parametrize( + "request_type", + [ + controller.RegisterDebuggeeRequest, + dict, + ], +) +def test_register_debuggee_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.register_debuggee(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.RegisterDebuggeeResponse) + + +def test_register_debuggee_rest_required_fields( + request_type=controller.RegisterDebuggeeRequest, +): + transport_class = transports.Controller2RestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.register_debuggee(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_register_debuggee_rest_unset_required_fields(): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.register_debuggee._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("debuggee",))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_register_debuggee_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Controller2RestInterceptor, "post_register_debuggee" + ) as post, mock.patch.object( + transports.Controller2RestInterceptor, "pre_register_debuggee" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.RegisterDebuggeeRequest.pb( + controller.RegisterDebuggeeRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.RegisterDebuggeeResponse.to_json( + controller.RegisterDebuggeeResponse() + ) + + request = controller.RegisterDebuggeeRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.RegisterDebuggeeResponse() + + client.register_debuggee( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_register_debuggee_rest_bad_request( + transport: str = "rest", request_type=controller.RegisterDebuggeeRequest +): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.register_debuggee(request) + + +def test_register_debuggee_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + debuggee=data.Debuggee(id="id_value"), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.register_debuggee(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/controller/debuggees/register" % client.transport._host, args[1] + ) + + +def test_register_debuggee_rest_flattened_error(transport: str = "rest"): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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"), + ) + + +def test_register_debuggee_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + controller.ListActiveBreakpointsRequest, + dict, + ], +) +def test_list_active_breakpoints_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse( + next_wait_token="next_wait_token_value", + wait_expired=True, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_active_breakpoints(request) + + # 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_rest_required_fields( + request_type=controller.ListActiveBreakpointsRequest, +): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_active_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = "debuggee_id_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_active_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "success_on_timeout", + "wait_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == "debuggee_id_value" + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_active_breakpoints(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_active_breakpoints_rest_unset_required_fields(): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_active_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "successOnTimeout", + "waitToken", + ) + ) + & set(("debuggeeId",)) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_active_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Controller2RestInterceptor, "post_list_active_breakpoints" + ) as post, mock.patch.object( + transports.Controller2RestInterceptor, "pre_list_active_breakpoints" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.ListActiveBreakpointsRequest.pb( + controller.ListActiveBreakpointsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.ListActiveBreakpointsResponse.to_json( + controller.ListActiveBreakpointsResponse() + ) + + request = controller.ListActiveBreakpointsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.ListActiveBreakpointsResponse() + + client.list_active_breakpoints( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_active_breakpoints_rest_bad_request( + transport: str = "rest", request_type=controller.ListActiveBreakpointsRequest +): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_active_breakpoints(request) + + +def test_list_active_breakpoints_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"debuggee_id": "sample1"} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id="debuggee_id_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_active_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/controller/debuggees/{debuggee_id}/breakpoints" + % client.transport._host, + args[1], + ) + + +def test_list_active_breakpoints_rest_flattened_error(transport: str = "rest"): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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", + ) + + +def test_list_active_breakpoints_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + controller.UpdateActiveBreakpointRequest, + dict, + ], +) +def test_update_active_breakpoint_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1", "breakpoint_": {"id": "sample2"}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.update_active_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.UpdateActiveBreakpointResponse) + + +def test_update_active_breakpoint_rest_required_fields( + request_type=controller.UpdateActiveBreakpointRequest, +): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = "debuggee_id_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == "debuggee_id_value" + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "put", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.update_active_breakpoint(request) + + expected_params = [("$alt", "json;enum-encoding=int")] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_update_active_breakpoint_rest_unset_required_fields(): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.update_active_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(()) + & set( + ( + "debuggeeId", + "breakpoint", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_active_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None + if null_interceptor + else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Controller2RestInterceptor, "post_update_active_breakpoint" + ) as post, mock.patch.object( + transports.Controller2RestInterceptor, "pre_update_active_breakpoint" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.UpdateActiveBreakpointRequest.pb( + controller.UpdateActiveBreakpointRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.UpdateActiveBreakpointResponse.to_json( + controller.UpdateActiveBreakpointResponse() + ) + + request = controller.UpdateActiveBreakpointRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.UpdateActiveBreakpointResponse() + + client.update_active_breakpoint( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_active_breakpoint_rest_bad_request( + transport: str = "rest", request_type=controller.UpdateActiveBreakpointRequest +): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1", "breakpoint_": {"id": "sample2"}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_active_breakpoint(request) + + +def test_update_active_breakpoint_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"debuggee_id": "sample1", "breakpoint_": {"id": "sample2"}} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id="debuggee_id_value", + breakpoint_=data.Breakpoint(id="id_value"), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.update_active_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}" + % client.transport._host, + args[1], + ) + + +def test_update_active_breakpoint_rest_flattened_error(transport: str = "rest"): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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"), + ) + + +def test_update_active_breakpoint_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + def test_credentials_transport_error(): # It is an error to provide credentials and a transport instance. transport = transports.Controller2GrpcTransport( @@ -1424,6 +2266,7 @@ def test_transport_get_channel(): [ transports.Controller2GrpcTransport, transports.Controller2GrpcAsyncIOTransport, + transports.Controller2RestTransport, ], ) def test_transport_adc(transport_class): @@ -1438,6 +2281,7 @@ def test_transport_adc(transport_class): "transport_name", [ "grpc", + "rest", ], ) def test_transport_kind(transport_name): @@ -1578,6 +2422,7 @@ def test_controller2_transport_auth_adc(transport_class): [ transports.Controller2GrpcTransport, transports.Controller2GrpcAsyncIOTransport, + transports.Controller2RestTransport, ], ) def test_controller2_transport_auth_gdch_credentials(transport_class): @@ -1675,11 +2520,23 @@ def test_controller2_grpc_transport_client_cert_source_for_mtls(transport_class) ) +def test_controller2_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.Controller2RestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_controller2_host_no_port(transport_name): @@ -1690,7 +2547,11 @@ def test_controller2_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("clouddebugger.googleapis.com:443") + assert client.transport._host == ( + "clouddebugger.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com" + ) @pytest.mark.parametrize( @@ -1698,6 +2559,7 @@ def test_controller2_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_controller2_host_with_port(transport_name): @@ -1708,7 +2570,39 @@ def test_controller2_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("clouddebugger.googleapis.com:8000") + assert client.transport._host == ( + "clouddebugger.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_controller2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Controller2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Controller2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.register_debuggee._session + session2 = client2.transport.register_debuggee._session + assert session1 != session2 + session1 = client1.transport.list_active_breakpoints._session + session2 = client2.transport.list_active_breakpoints._session + assert session1 != session2 + session1 = client1.transport.update_active_breakpoint._session + session2 = client2.transport.update_active_breakpoint._session + assert session1 != session2 def test_controller2_grpc_transport_channel(): @@ -1971,6 +2865,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -1988,6 +2883,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: diff --git a/tests/unit/gapic/debugger_v2/test_debugger2.py b/tests/unit/gapic/debugger_v2/test_debugger2.py index 0ad86df..329180d 100644 --- a/tests/unit/gapic/debugger_v2/test_debugger2.py +++ b/tests/unit/gapic/debugger_v2/test_debugger2.py @@ -22,6 +22,8 @@ except ImportError: # pragma: NO COVER import mock +from collections.abc import Iterable +import json import math from google.api_core import gapic_v1, grpc_helpers, grpc_helpers_async, path_template @@ -31,6 +33,7 @@ from google.auth import credentials as ga_credentials from google.auth.exceptions import MutualTLSChannelError from google.oauth2 import service_account +from google.protobuf import json_format from google.protobuf import timestamp_pb2 # type: ignore from google.protobuf import wrappers_pb2 # type: ignore import grpc @@ -38,6 +41,8 @@ from proto.marshal.rules import wrappers from proto.marshal.rules.dates import DurationRule, TimestampRule import pytest +from requests import PreparedRequest, Request, Response +from requests.sessions import Session from google.cloud.debugger_v2.services.debugger2 import ( Debugger2AsyncClient, @@ -91,6 +96,7 @@ def test__get_default_mtls_endpoint(): [ (Debugger2Client, "grpc"), (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), ], ) def test_debugger2_client_from_service_account_info(client_class, transport_name): @@ -104,7 +110,11 @@ def test_debugger2_client_from_service_account_info(client_class, transport_name assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("clouddebugger.googleapis.com:443") + assert client.transport._host == ( + "clouddebugger.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com" + ) @pytest.mark.parametrize( @@ -112,6 +122,7 @@ def test_debugger2_client_from_service_account_info(client_class, transport_name [ (transports.Debugger2GrpcTransport, "grpc"), (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Debugger2RestTransport, "rest"), ], ) def test_debugger2_client_service_account_always_use_jwt( @@ -137,6 +148,7 @@ def test_debugger2_client_service_account_always_use_jwt( [ (Debugger2Client, "grpc"), (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), ], ) def test_debugger2_client_from_service_account_file(client_class, transport_name): @@ -157,13 +169,18 @@ def test_debugger2_client_from_service_account_file(client_class, transport_name assert client.transport._credentials == creds assert isinstance(client, client_class) - assert client.transport._host == ("clouddebugger.googleapis.com:443") + assert client.transport._host == ( + "clouddebugger.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com" + ) def test_debugger2_client_get_transport_class(): transport = Debugger2Client.get_transport_class() available_transports = [ transports.Debugger2GrpcTransport, + transports.Debugger2RestTransport, ] assert transport in available_transports @@ -180,6 +197,7 @@ def test_debugger2_client_get_transport_class(): transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", ), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), ], ) @mock.patch.object( @@ -321,6 +339,8 @@ def test_debugger2_client_client_options(client_class, transport_class, transpor "grpc_asyncio", "false", ), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "true"), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "false"), ], ) @mock.patch.object( @@ -514,6 +534,7 @@ def test_debugger2_client_get_mtls_endpoint_and_cert_source(client_class): transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio", ), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), ], ) def test_debugger2_client_client_options_scopes( @@ -549,6 +570,7 @@ def test_debugger2_client_client_options_scopes( "grpc_asyncio", grpc_helpers_async, ), + (Debugger2Client, transports.Debugger2RestTransport, "rest", None), ], ) def test_debugger2_client_client_options_credentials_file( @@ -1824,191 +1846,1763 @@ async def test_list_debuggees_flattened_error_async(): ) -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.Debugger2GrpcTransport( +@pytest.mark.parametrize( + "request_type", + [ + debugger.SetBreakpointRequest, + dict, + ], +) +def test_set_breakpoint_rest(request_type): + client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - 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(), + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1"} + request_init["breakpoint_"] = { + "id": "id_value", + "action": 1, + "location": {"path": "path_value", "line": 424, "column": 654}, + "condition": "condition_value", + "expressions": ["expressions_value1", "expressions_value2"], + "log_message_format": "log_message_format_value", + "log_level": 1, + "is_final_state": True, + "create_time": {"seconds": 751, "nanos": 543}, + "final_time": {}, + "user_email": "user_email_value", + "status": { + "is_error": True, + "refers_to": 3, + "description": { + "format_": "format__value", + "parameters": ["parameters_value1", "parameters_value2"], + }, + }, + "stack_frames": [ + { + "function": "function_value", + "location": {}, + "arguments": [ + { + "name": "name_value", + "value": "value_value", + "type_": "type__value", + "members": {}, + "var_table_index": {"value": 541}, + "status": {}, + } + ], + "locals_": {}, + } + ], + "evaluated_expressions": {}, + "variable_table": {}, + "labels": {}, + } + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.set_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.SetBreakpointResponse) + + +def test_set_breakpoint_rest_required_fields( + request_type=debugger.SetBreakpointRequest, +): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) ) - with pytest.raises(ValueError): - client = Debugger2Client( - client_options={"credentials_file": "credentials.json"}, - transport=transport, + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).set_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = "debuggee_id_value" + jsonified_request["clientVersion"] = "client_version_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).set_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "breakpoint_", + "client_version", ) + ) + jsonified_request.update(unset_fields) - # It is an error to provide an api_key and a transport instance. - transport = transports.Debugger2GrpcTransport( + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == "debuggee_id_value" + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == "client_version_value" + + client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "post", + "query_params": pb_request, + } + transcode_result["body"] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.set_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_set_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport( + 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() + unset_fields = transport.set_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "breakpoint", + "clientVersion", + ) + ) + & set( + ( + "debuggeeId", + "breakpoint", + "clientVersion", + ) ) + ) - # It is an error to provide scopes and a transport instance. - transport = transports.Debugger2GrpcTransport( + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_set_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), ) - with pytest.raises(ValueError): - client = Debugger2Client( - client_options={"scopes": ["1", "2"]}, - transport=transport, + client = Debugger2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Debugger2RestInterceptor, "post_set_breakpoint" + ) as post, mock.patch.object( + transports.Debugger2RestInterceptor, "pre_set_breakpoint" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.SetBreakpointRequest.pb(debugger.SetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.SetBreakpointResponse.to_json( + debugger.SetBreakpointResponse() ) + request = debugger.SetBreakpointRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.SetBreakpointResponse() -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.Debugger2GrpcTransport( + client.set_breakpoint( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_set_breakpoint_rest_bad_request( + transport: str = "rest", request_type=debugger.SetBreakpointRequest +): + client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - client = Debugger2Client(transport=transport) - assert client.transport is transport + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1"} + request_init["breakpoint_"] = { + "id": "id_value", + "action": 1, + "location": {"path": "path_value", "line": 424, "column": 654}, + "condition": "condition_value", + "expressions": ["expressions_value1", "expressions_value2"], + "log_message_format": "log_message_format_value", + "log_level": 1, + "is_final_state": True, + "create_time": {"seconds": 751, "nanos": 543}, + "final_time": {}, + "user_email": "user_email_value", + "status": { + "is_error": True, + "refers_to": 3, + "description": { + "format_": "format__value", + "parameters": ["parameters_value1", "parameters_value2"], + }, + }, + "stack_frames": [ + { + "function": "function_value", + "location": {}, + "arguments": [ + { + "name": "name_value", + "value": "value_value", + "type_": "type__value", + "members": {}, + "var_table_index": {"value": 541}, + "status": {}, + } + ], + "locals_": {}, + } + ], + "evaluated_expressions": {}, + "variable_table": {}, + "labels": {}, + } + request = request_type(**request_init) -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.Debugger2GrpcTransport( + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.set_breakpoint(request) + + +def test_set_breakpoint_rest_flattened(): + client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - channel = transport.grpc_channel - assert channel - transport = transports.Debugger2GrpcAsyncIOTransport( + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"debuggee_id": "sample1"} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id="debuggee_id_value", + breakpoint_=data.Breakpoint(id="id_value"), + client_version="client_version_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.set_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/set" + % client.transport._host, + args[1], + ) + + +def test_set_breakpoint_rest_flattened_error(transport: str = "rest"): + client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - channel = transport.grpc_channel - assert channel + + # 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.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_set_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) @pytest.mark.parametrize( - "transport_name", + "request_type", [ - "grpc", + debugger.GetBreakpointRequest, + dict, ], ) -def test_transport_kind(transport_name): - transport = Debugger2Client.get_transport_class(transport_name)( +def test_get_breakpoint_rest(request_type): + client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - assert transport.kind == transport_name + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1", "breakpoint_id": "sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.get_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.GetBreakpointResponse) + + +def test_get_breakpoint_rest_required_fields( + request_type=debugger.GetBreakpointRequest, +): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = "debuggee_id_value" + jsonified_request["breakpointId"] = "breakpoint_id_value" + jsonified_request["clientVersion"] = "client_version_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).get_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == "debuggee_id_value" + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == "breakpoint_id_value" + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == "client_version_value" -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. client = Debugger2Client( credentials=ga_credentials.AnonymousCredentials(), + transport="rest", ) - assert isinstance( - client.transport, - transports.Debugger2GrpcTransport, + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.get_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_get_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials ) + unset_fields = transport.get_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("clientVersion",)) + & set( + ( + "debuggeeId", + "breakpointId", + "clientVersion", + ) + ) + ) -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", + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Debugger2RestInterceptor, "post_get_breakpoint" + ) as post, mock.patch.object( + transports.Debugger2RestInterceptor, "pre_get_breakpoint" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.GetBreakpointRequest.pb(debugger.GetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.GetBreakpointResponse.to_json( + debugger.GetBreakpointResponse() ) + request = debugger.GetBreakpointRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.GetBreakpointResponse() -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(), + client.get_breakpoint( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], ) - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - "set_breakpoint", - "get_breakpoint", - "delete_breakpoint", - "list_breakpoints", - "list_debuggees", + pre.assert_called_once() + post.assert_called_once() + + +def test_get_breakpoint_rest_bad_request( + transport: str = "rest", request_type=debugger.GetBreakpointRequest +): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, ) - for method in methods: - with pytest.raises(NotImplementedError): - getattr(transport, method)(request=object()) - with pytest.raises(NotImplementedError): - transport.close() + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1", "breakpoint_id": "sample2"} + request = request_type(**request_init) - # Catch all for all remaining methods and properties - remainder = [ - "kind", - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_breakpoint(request) -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_get_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() -def test_debugger2_base_transport_with_adc(): - # Test the default credentials are used if credentials and credentials_file are None. + # get arguments that satisfy an http rule for this method + sample_request = {"debuggee_id": "sample1", "breakpoint_id": "sample2"} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.get_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" + % client.transport._host, + args[1], + ) + + +def test_get_breakpoint_rest_flattened_error(transport: str = "rest"): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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", + ) + + +def test_get_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + debugger.DeleteBreakpointRequest, + dict, + ], +) +def test_delete_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1", "breakpoint_id": "sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.delete_breakpoint(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_breakpoint_rest_required_fields( + request_type=debugger.DeleteBreakpointRequest, +): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = "debuggee_id_value" + jsonified_request["breakpointId"] = "breakpoint_id_value" + jsonified_request["clientVersion"] = "client_version_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).delete_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version",)) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == "debuggee_id_value" + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == "breakpoint_id_value" + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == "client_version_value" + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "delete", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.delete_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_delete_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.delete_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == ( + set(("clientVersion",)) + & set( + ( + "debuggeeId", + "breakpointId", + "clientVersion", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Debugger2RestInterceptor, "pre_delete_breakpoint" + ) as pre: + pre.assert_not_called() + pb_message = debugger.DeleteBreakpointRequest.pb( + debugger.DeleteBreakpointRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = debugger.DeleteBreakpointRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_breakpoint( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + + +def test_delete_breakpoint_rest_bad_request( + transport: str = "rest", request_type=debugger.DeleteBreakpointRequest +): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1", "breakpoint_id": "sample2"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_breakpoint(request) + + +def test_delete_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {"debuggee_id": "sample1", "breakpoint_id": "sample2"} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = "" + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.delete_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" + % client.transport._host, + args[1], + ) + + +def test_delete_breakpoint_rest_flattened_error(transport: str = "rest"): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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", + ) + + +def test_delete_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + debugger.ListBreakpointsRequest, + dict, + ], +) +def test_list_breakpoints_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse( + next_wait_token="next_wait_token_value", + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_breakpoints(request) + + # 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_rest_required_fields( + request_type=debugger.ListBreakpointsRequest, +): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = "debuggee_id_value" + jsonified_request["clientVersion"] = "client_version_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "action", + "client_version", + "include_all_users", + "include_inactive", + "strip_results", + "wait_token", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == "debuggee_id_value" + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == "client_version_value" + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_breakpoints(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_breakpoints_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "action", + "clientVersion", + "includeAllUsers", + "includeInactive", + "stripResults", + "waitToken", + ) + ) + & set( + ( + "debuggeeId", + "clientVersion", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Debugger2RestInterceptor, "post_list_breakpoints" + ) as post, mock.patch.object( + transports.Debugger2RestInterceptor, "pre_list_breakpoints" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListBreakpointsRequest.pb( + debugger.ListBreakpointsRequest() + ) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListBreakpointsResponse.to_json( + debugger.ListBreakpointsResponse() + ) + + request = debugger.ListBreakpointsRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListBreakpointsResponse() + + client.list_breakpoints( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_breakpoints_rest_bad_request( + transport: str = "rest", request_type=debugger.ListBreakpointsRequest +): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {"debuggee_id": "sample1"} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_breakpoints(request) + + +def test_list_breakpoints_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {"debuggee_id": "sample1"} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/debugger/debuggees/{debuggee_id}/breakpoints" + % client.transport._host, + args[1], + ) + + +def test_list_breakpoints_rest_flattened_error(transport: str = "rest"): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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", + ) + + +def test_list_breakpoints_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +@pytest.mark.parametrize( + "request_type", + [ + debugger.ListDebuggeesRequest, + dict, + ], +) +def test_list_debuggees_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + response = client.list_debuggees(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.ListDebuggeesResponse) + + +def test_list_debuggees_rest_required_fields( + request_type=debugger.ListDebuggeesRequest, +): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["project"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads( + json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False, + ) + ) + + # verify fields with default values are dropped + assert "project" not in jsonified_request + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_debuggees._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "project" in jsonified_request + assert jsonified_request["project"] == request_init["project"] + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["project"] = "project_value" + jsonified_request["clientVersion"] = "client_version_value" + + unset_fields = transport_class( + credentials=ga_credentials.AnonymousCredentials() + ).list_debuggees._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set( + ( + "client_version", + "include_inactive", + "project", + ) + ) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "project" in jsonified_request + assert jsonified_request["project"] == "project_value" + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == "client_version_value" + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, "request") as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, "transcode") as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + "uri": "v1/sample_method", + "method": "get", + "query_params": pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + response = client.list_debuggees(request) + + expected_params = [ + ( + "project", + "", + ), + ( + "clientVersion", + "", + ), + ("$alt", "json;enum-encoding=int"), + ] + actual_params = req.call_args.kwargs["params"] + assert expected_params == actual_params + + +def test_list_debuggees_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials + ) + + unset_fields = transport.list_debuggees._get_unset_required_fields({}) + assert set(unset_fields) == ( + set( + ( + "clientVersion", + "includeInactive", + "project", + ) + ) + & set( + ( + "project", + "clientVersion", + ) + ) + ) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_debuggees_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object( + type(client.transport._session), "request" + ) as req, mock.patch.object( + path_template, "transcode" + ) as transcode, mock.patch.object( + transports.Debugger2RestInterceptor, "post_list_debuggees" + ) as post, mock.patch.object( + transports.Debugger2RestInterceptor, "pre_list_debuggees" + ) as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListDebuggeesRequest.pb(debugger.ListDebuggeesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListDebuggeesResponse.to_json( + debugger.ListDebuggeesResponse() + ) + + request = debugger.ListDebuggeesRequest() + metadata = [ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListDebuggeesResponse() + + client.list_debuggees( + request, + metadata=[ + ("key", "val"), + ("cephalopod", "squid"), + ], + ) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_debuggees_rest_bad_request( + transport: str = "rest", request_type=debugger.ListDebuggeesRequest +): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, "request") as req, pytest.raises( + core_exceptions.BadRequest + ): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_debuggees(request) + + +def test_list_debuggees_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), "request") as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + project="project_value", + client_version="client_version_value", + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode("UTF-8") + req.return_value = response_value + + client.list_debuggees(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate( + "%s/v2/debugger/debuggees" % client.transport._host, args[1] + ) + + +def test_list_debuggees_rest_flattened_error(transport: str = "rest"): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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", + ) + + +def test_list_debuggees_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), transport="rest" + ) + + +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, + transports.Debugger2RestTransport, + ], +) +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() + + +@pytest.mark.parametrize( + "transport_name", + [ + "grpc", + "rest", + ], +) +def test_transport_kind(transport_name): + transport = Debugger2Client.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + + +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() + + # Catch all for all remaining methods and properties + remainder = [ + "kind", + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +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: @@ -2061,6 +3655,7 @@ def test_debugger2_transport_auth_adc(transport_class): [ transports.Debugger2GrpcTransport, transports.Debugger2GrpcAsyncIOTransport, + transports.Debugger2RestTransport, ], ) def test_debugger2_transport_auth_gdch_credentials(transport_class): @@ -2158,11 +3753,23 @@ def test_debugger2_grpc_transport_client_cert_source_for_mtls(transport_class): ) +def test_debugger2_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch( + "google.auth.transport.requests.AuthorizedSession.configure_mtls_channel" + ) as mock_configure_mtls_channel: + transports.Debugger2RestTransport( + credentials=cred, client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + @pytest.mark.parametrize( "transport_name", [ "grpc", "grpc_asyncio", + "rest", ], ) def test_debugger2_host_no_port(transport_name): @@ -2173,7 +3780,11 @@ def test_debugger2_host_no_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("clouddebugger.googleapis.com:443") + assert client.transport._host == ( + "clouddebugger.googleapis.com:443" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com" + ) @pytest.mark.parametrize( @@ -2181,6 +3792,7 @@ def test_debugger2_host_no_port(transport_name): [ "grpc", "grpc_asyncio", + "rest", ], ) def test_debugger2_host_with_port(transport_name): @@ -2191,7 +3803,45 @@ def test_debugger2_host_with_port(transport_name): ), transport=transport_name, ) - assert client.transport._host == ("clouddebugger.googleapis.com:8000") + assert client.transport._host == ( + "clouddebugger.googleapis.com:8000" + if transport_name in ["grpc", "grpc_asyncio"] + else "https://clouddebugger.googleapis.com:8000" + ) + + +@pytest.mark.parametrize( + "transport_name", + [ + "rest", + ], +) +def test_debugger2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Debugger2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Debugger2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.set_breakpoint._session + session2 = client2.transport.set_breakpoint._session + assert session1 != session2 + session1 = client1.transport.get_breakpoint._session + session2 = client2.transport.get_breakpoint._session + assert session1 != session2 + session1 = client1.transport.delete_breakpoint._session + session2 = client2.transport.delete_breakpoint._session + assert session1 != session2 + session1 = client1.transport.list_breakpoints._session + session2 = client2.transport.list_breakpoints._session + assert session1 != session2 + session1 = client1.transport.list_debuggees._session + session2 = client2.transport.list_debuggees._session + assert session1 != session2 def test_debugger2_grpc_transport_channel(): @@ -2454,6 +4104,7 @@ async def test_transport_close_async(): def test_transport_close(): transports = { + "rest": "_session", "grpc": "_grpc_channel", } @@ -2471,6 +4122,7 @@ def test_transport_close(): def test_client_ctx(): transports = [ + "rest", "grpc", ] for transport in transports: From c09abd8571b0b661910d73f570625c3df2148454 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Fri, 24 Feb 2023 01:59:49 +0000 Subject: [PATCH 03/10] chore: Update gapic-generator-python to v1.8.5 PiperOrigin-RevId: 511892190 Source-Link: https://github.com/googleapis/googleapis/commit/a45d9c09c1287ffdf938f4e8083e791046c0b23b Source-Link: https://github.com/googleapis/googleapis-gen/commit/1907294b1d8365ea24f8c5f2e059a64124c4ed3b Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMTkwNzI5NGIxZDgzNjVlYTI0ZjhjNWYyZTA1OWE2NDEyNGM0ZWQzYiJ9 --- owl-bot-staging/v2/.coveragerc | 13 + owl-bot-staging/v2/.flake8 | 33 + 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 | 6 + owl-bot-staging/v2/docs/index.rst | 7 + .../v2/google/cloud/debugger/__init__.py | 75 + .../v2/google/cloud/debugger/gapic_version.py | 16 + .../v2/google/cloud/debugger/py.typed | 2 + .../v2/google/cloud/debugger_v2/__init__.py | 76 + .../cloud/debugger_v2/gapic_metadata.json | 167 + .../google/cloud/debugger_v2/gapic_version.py | 16 + .../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 | 566 +++ .../services/controller2/client.py | 747 ++++ .../controller2/transports/__init__.py | 38 + .../services/controller2/transports/base.py | 191 + .../services/controller2/transports/grpc.py | 369 ++ .../controller2/transports/grpc_asyncio.py | 368 ++ .../services/controller2/transports/rest.py | 554 +++ .../services/debugger2/__init__.py | 22 + .../services/debugger2/async_client.py | 806 ++++ .../debugger_v2/services/debugger2/client.py | 973 +++++ .../services/debugger2/transports/__init__.py | 38 + .../services/debugger2/transports/base.py | 234 ++ .../services/debugger2/transports/grpc.py | 381 ++ .../debugger2/transports/grpc_asyncio.py | 380 ++ .../services/debugger2/transports/rest.py | 730 ++++ .../cloud/debugger_v2/types/__init__.py | 68 + .../cloud/debugger_v2/types/controller.py | 176 + .../v2/google/cloud/debugger_v2/types/data.py | 681 ++++ .../cloud/debugger_v2/types/debugger.py | 315 ++ owl-bot-staging/v2/mypy.ini | 3 + owl-bot-staging/v2/noxfile.py | 184 + ...ntroller2_list_active_breakpoints_async.py | 52 + ...ontroller2_list_active_breakpoints_sync.py | 52 + ...ted_controller2_register_debuggee_async.py | 51 + ...ated_controller2_register_debuggee_sync.py | 51 + ...troller2_update_active_breakpoint_async.py | 52 + ...ntroller2_update_active_breakpoint_sync.py | 52 + ...rated_debugger2_delete_breakpoint_async.py | 52 + ...erated_debugger2_delete_breakpoint_sync.py | 52 + ...enerated_debugger2_get_breakpoint_async.py | 54 + ...generated_debugger2_get_breakpoint_sync.py | 54 + ...erated_debugger2_list_breakpoints_async.py | 53 + ...nerated_debugger2_list_breakpoints_sync.py | 53 + ...enerated_debugger2_list_debuggees_async.py | 53 + ...generated_debugger2_list_debuggees_sync.py | 53 + ...enerated_debugger2_set_breakpoint_async.py | 53 + ...generated_debugger2_set_breakpoint_sync.py | 53 + ...data_google.devtools.clouddebugger.v2.json | 1369 +++++++ .../v2/scripts/fixup_debugger_v2_keywords.py | 183 + owl-bot-staging/v2/setup.py | 90 + .../v2/testing/constraints-3.10.txt | 6 + .../v2/testing/constraints-3.11.txt | 6 + .../v2/testing/constraints-3.12.txt | 6 + .../v2/testing/constraints-3.7.txt | 9 + .../v2/testing/constraints-3.8.txt | 6 + .../v2/testing/constraints-3.9.txt | 6 + 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 | 2551 ++++++++++++ .../unit/gapic/debugger_v2/test_debugger2.py | 3628 +++++++++++++++++ 71 files changed, 17484 insertions(+) create mode 100644 owl-bot-staging/v2/.coveragerc create mode 100644 owl-bot-staging/v2/.flake8 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/gapic_version.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/gapic_version.py 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/controller2/transports/rest.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/services/debugger2/transports/rest.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/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json 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/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.9.txt 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..9620812 --- /dev/null +++ b/owl-bot-staging/v2/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/debugger/__init__.py + google/cloud/debugger/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v2/.flake8 b/owl-bot-staging/v2/.flake8 new file mode 100644 index 0000000..29227d4 --- /dev/null +++ b/owl-bot-staging/v2/.flake8 @@ -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 +# +# https://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. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py 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..4ad5ea1 --- /dev/null +++ b/owl-bot-staging/v2/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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"2022, 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..0106467 --- /dev/null +++ b/owl-bot-staging/v2/docs/debugger_v2/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Debugger v2 API +====================================== + +.. automodule:: google.cloud.debugger_v2.types + :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..1228468 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger/__init__.py @@ -0,0 +1,75 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 import gapic_version as package_version + +__version__ = package_version.__version__ + + +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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +__version__ = "0.1.0" # {x-release-please-version} 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..c774017 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 import gapic_version as package_version + +__version__ = package_version.__version__ + + +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..f0d8a90 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json @@ -0,0 +1,167 @@ + { + "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" + ] + } + } + }, + "rest": { + "libraryClient": "Controller2Client", + "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" + ] + } + } + }, + "rest": { + "libraryClient": "Debugger2Client", + "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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +__version__ = "0.1.0" # {x-release-please-version} 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..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..e010a73 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..aa29878 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py @@ -0,0 +1,566 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 variable 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: Optional[ga_credentials.Credentials] = None, + transport: Union[str, Controller2Transport] = "grpc_asyncio", + client_options: Optional[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: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, + *, + debuggee: Optional[data.Debuggee] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = await client.register_debuggee(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint.id", request.breakpoint.id), + )), + ) + + # 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() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..7330718 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py @@ -0,0 +1,747 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 +from .transports.rest import Controller2RestTransport + + +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 + _transport_registry["rest"] = Controller2RestTransport + + def get_transport_class(cls, + label: Optional[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 variable 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: Optional[Union[str, Controller2Transport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() + client_options = cast(client_options_lib.ClientOptions, client_options) + + 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, + api_audience=client_options.api_audience, + ) + + def register_debuggee(self, + request: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, + *, + debuggee: Optional[data.Debuggee] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = client.register_debuggee(request=request) + + # Handle the response + print(response) + + 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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_active_breakpoint(self, + request: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint.id", request.breakpoint.id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "Controller2Client": + 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() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..0381ff4 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +from .rest import Controller2RestTransport +from .rest import Controller2RestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] +_transport_registry['grpc'] = Controller2GrpcTransport +_transport_registry['grpc_asyncio'] = Controller2GrpcAsyncIOTransport +_transport_registry['rest'] = Controller2RestTransport + +__all__ = ( + 'Controller2Transport', + 'Controller2GrpcTransport', + 'Controller2GrpcAsyncIOTransport', + 'Controller2RestTransport', + 'Controller2RestInterceptor', +) 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..8e480a6 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py @@ -0,0 +1,191 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +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: Optional[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, + api_audience: Optional[str] = None, + **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. + """ + + 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) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # 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 + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + 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() + + @property + def kind(self) -> str: + 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..09e2efa --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py @@ -0,0 +1,369 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[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() + + @property + def kind(self) -> str: + return "grpc" + + +__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..ae65db1 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py @@ -0,0 +1,368 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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/controller2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py new file mode 100644 index 0000000..3bd7006 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py @@ -0,0 +1,554 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +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 .base import Controller2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class Controller2RestInterceptor: + """Interceptor for Controller2. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the Controller2RestTransport. + + .. code-block:: python + class MyCustomController2Interceptor(Controller2RestInterceptor): + def pre_list_active_breakpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_active_breakpoints(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_register_debuggee(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_register_debuggee(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_active_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_active_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + transport = Controller2RestTransport(interceptor=MyCustomController2Interceptor()) + client = Controller2Client(transport=transport) + + + """ + def pre_list_active_breakpoints(self, request: controller.ListActiveBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.ListActiveBreakpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_active_breakpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_list_active_breakpoints(self, response: controller.ListActiveBreakpointsResponse) -> controller.ListActiveBreakpointsResponse: + """Post-rpc interceptor for list_active_breakpoints + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + def pre_register_debuggee(self, request: controller.RegisterDebuggeeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.RegisterDebuggeeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for register_debuggee + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_register_debuggee(self, response: controller.RegisterDebuggeeResponse) -> controller.RegisterDebuggeeResponse: + """Post-rpc interceptor for register_debuggee + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + def pre_update_active_breakpoint(self, request: controller.UpdateActiveBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.UpdateActiveBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_active_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_update_active_breakpoint(self, response: controller.UpdateActiveBreakpointResponse) -> controller.UpdateActiveBreakpointResponse: + """Post-rpc interceptor for update_active_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class Controller2RestStub: + _session: AuthorizedSession + _host: str + _interceptor: Controller2RestInterceptor + + +class Controller2RestTransport(Controller2Transport): + """REST 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 JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[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, + url_scheme: str = 'https', + interceptor: Optional[Controller2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> 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 ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` 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 are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or Controller2RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _ListActiveBreakpoints(Controller2RestStub): + def __hash__(self): + return hash("ListActiveBreakpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.ListActiveBreakpointsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.ListActiveBreakpointsResponse: + r"""Call the list active breakpoints method over HTTP. + + Args: + request (~.controller.ListActiveBreakpointsRequest): + The request object. Request to list active breakpoints. + 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: + ~.controller.ListActiveBreakpointsResponse: + Response for listing active + breakpoints. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints', + }, + ] + request, metadata = self._interceptor.pre_list_active_breakpoints(request, metadata) + pb_request = controller.ListActiveBreakpointsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.ListActiveBreakpointsResponse() + pb_resp = controller.ListActiveBreakpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_active_breakpoints(resp) + return resp + + class _RegisterDebuggee(Controller2RestStub): + def __hash__(self): + return hash("RegisterDebuggee") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.RegisterDebuggeeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.RegisterDebuggeeResponse: + r"""Call the register debuggee method over HTTP. + + Args: + request (~.controller.RegisterDebuggeeRequest): + The request object. Request to register a debuggee. + 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: + ~.controller.RegisterDebuggeeResponse: + Response for registering a debuggee. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/controller/debuggees/register', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_register_debuggee(request, metadata) + pb_request = controller.RegisterDebuggeeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.RegisterDebuggeeResponse() + pb_resp = controller.RegisterDebuggeeResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_register_debuggee(resp) + return resp + + class _UpdateActiveBreakpoint(Controller2RestStub): + def __hash__(self): + return hash("UpdateActiveBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.UpdateActiveBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.UpdateActiveBreakpointResponse: + r"""Call the update active breakpoint method over HTTP. + + Args: + request (~.controller.UpdateActiveBreakpointRequest): + The request object. Request to update an active + breakpoint. + + 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: + ~.controller.UpdateActiveBreakpointResponse: + Response for updating an active + breakpoint. The message is defined to + allow future extensions. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'put', + 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_update_active_breakpoint(request, metadata) + pb_request = controller.UpdateActiveBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.UpdateActiveBreakpointResponse() + pb_resp = controller.UpdateActiveBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_active_breakpoint(resp) + return resp + + @property + def list_active_breakpoints(self) -> Callable[ + [controller.ListActiveBreakpointsRequest], + controller.ListActiveBreakpointsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListActiveBreakpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def register_debuggee(self) -> Callable[ + [controller.RegisterDebuggeeRequest], + controller.RegisterDebuggeeResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RegisterDebuggee(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_active_breakpoint(self) -> Callable[ + [controller.UpdateActiveBreakpointRequest], + controller.UpdateActiveBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateActiveBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'Controller2RestTransport', +) 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..5d7f609 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..257c378 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py @@ -0,0 +1,806 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 variable 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: Optional[ga_credentials.Credentials] = None, + transport: Union[str, Debugger2Transport] = "grpc_asyncio", + client_options: Optional[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: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Sets the breakpoint to the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.set_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Gets breakpoint information. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.get_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # 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: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the breakpoint from the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + await client.delete_breakpoint(request=request) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def list_breakpoints(self, + request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Lists all breakpoints for the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_breakpoints(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, + *, + project: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Lists all the debuggees that the user has access to. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_debuggees(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..7e52f8d --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py @@ -0,0 +1,973 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 +from .transports.rest import Debugger2RestTransport + + +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 + _transport_registry["rest"] = Debugger2RestTransport + + def get_transport_class(cls, + label: Optional[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 variable 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: Optional[Union[str, Debugger2Transport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() + client_options = cast(client_options_lib.ClientOptions, client_options) + + 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, + api_audience=client_options.api_audience, + ) + + def set_breakpoint(self, + request: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Sets the breakpoint to the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.set_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_breakpoint(self, + request: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Gets breakpoint information. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.get_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_breakpoint(self, + request: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the breakpoint from the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + client.delete_breakpoint(request=request) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def list_breakpoints(self, + request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Lists all breakpoints for the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_breakpoints(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_debuggees(self, + request: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, + *, + project: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Lists all the debuggees that the user has access to. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_debuggees(request=request) + + # Handle the response + print(response) + + 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) -> "Debugger2Client": + 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() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..cd9dd46 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +from .rest import Debugger2RestTransport +from .rest import Debugger2RestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] +_transport_registry['grpc'] = Debugger2GrpcTransport +_transport_registry['grpc_asyncio'] = Debugger2GrpcAsyncIOTransport +_transport_registry['rest'] = Debugger2RestTransport + +__all__ = ( + 'Debugger2Transport', + 'Debugger2GrpcTransport', + 'Debugger2GrpcAsyncIOTransport', + 'Debugger2RestTransport', + 'Debugger2RestInterceptor', +) 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..c4afc0c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py @@ -0,0 +1,234 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +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: Optional[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, + api_audience: Optional[str] = None, + **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. + """ + + 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) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # 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 + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + 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() + + @property + def kind(self) -> str: + 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..fbb3374 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py @@ -0,0 +1,381 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[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() + + @property + def kind(self) -> str: + return "grpc" + + +__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..eb6eadc --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py @@ -0,0 +1,380 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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/services/debugger2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py new file mode 100644 index 0000000..f2373b6 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py @@ -0,0 +1,730 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +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 debugger +from google.protobuf import empty_pb2 # type: ignore + +from .base import Debugger2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class Debugger2RestInterceptor: + """Interceptor for Debugger2. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the Debugger2RestTransport. + + .. code-block:: python + class MyCustomDebugger2Interceptor(Debugger2RestInterceptor): + def pre_delete_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_breakpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_breakpoints(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_debuggees(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_debuggees(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_set_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_set_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + transport = Debugger2RestTransport(interceptor=MyCustomDebugger2Interceptor()) + client = Debugger2Client(transport=transport) + + + """ + def pre_delete_breakpoint(self, request: debugger.DeleteBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.DeleteBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def pre_get_breakpoint(self, request: debugger.GetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.GetBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_get_breakpoint(self, response: debugger.GetBreakpointResponse) -> debugger.GetBreakpointResponse: + """Post-rpc interceptor for get_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_list_breakpoints(self, request: debugger.ListBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListBreakpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_breakpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_list_breakpoints(self, response: debugger.ListBreakpointsResponse) -> debugger.ListBreakpointsResponse: + """Post-rpc interceptor for list_breakpoints + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_list_debuggees(self, request: debugger.ListDebuggeesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListDebuggeesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_debuggees + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_list_debuggees(self, response: debugger.ListDebuggeesResponse) -> debugger.ListDebuggeesResponse: + """Post-rpc interceptor for list_debuggees + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_set_breakpoint(self, request: debugger.SetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.SetBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for set_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_set_breakpoint(self, response: debugger.SetBreakpointResponse) -> debugger.SetBreakpointResponse: + """Post-rpc interceptor for set_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class Debugger2RestStub: + _session: AuthorizedSession + _host: str + _interceptor: Debugger2RestInterceptor + + +class Debugger2RestTransport(Debugger2Transport): + """REST 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 JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[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, + url_scheme: str = 'https', + interceptor: Optional[Debugger2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> 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 ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` 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 are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or Debugger2RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _DeleteBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("DeleteBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.DeleteBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the delete breakpoint method over HTTP. + + Args: + request (~.debugger.DeleteBreakpointRequest): + The request object. Request to delete a breakpoint. + 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. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', + }, + ] + request, metadata = self._interceptor.pre_delete_breakpoint(request, metadata) + pb_request = debugger.DeleteBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("GetBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.GetBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.GetBreakpointResponse: + r"""Call the get breakpoint method over HTTP. + + Args: + request (~.debugger.GetBreakpointRequest): + The request object. Request to get breakpoint + information. + + 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: + ~.debugger.GetBreakpointResponse: + Response for getting breakpoint + information. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', + }, + ] + request, metadata = self._interceptor.pre_get_breakpoint(request, metadata) + pb_request = debugger.GetBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.GetBreakpointResponse() + pb_resp = debugger.GetBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_breakpoint(resp) + return resp + + class _ListBreakpoints(Debugger2RestStub): + def __hash__(self): + return hash("ListBreakpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.ListBreakpointsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.ListBreakpointsResponse: + r"""Call the list breakpoints method over HTTP. + + Args: + request (~.debugger.ListBreakpointsRequest): + The request object. Request to list breakpoints. + 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: + ~.debugger.ListBreakpointsResponse: + Response for listing breakpoints. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints', + }, + ] + request, metadata = self._interceptor.pre_list_breakpoints(request, metadata) + pb_request = debugger.ListBreakpointsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.ListBreakpointsResponse() + pb_resp = debugger.ListBreakpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_breakpoints(resp) + return resp + + class _ListDebuggees(Debugger2RestStub): + def __hash__(self): + return hash("ListDebuggees") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "project" : "", "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.ListDebuggeesRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.ListDebuggeesResponse: + r"""Call the list debuggees method over HTTP. + + Args: + request (~.debugger.ListDebuggeesRequest): + The request object. Request to list debuggees. + 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: + ~.debugger.ListDebuggeesResponse: + Response for listing debuggees. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees', + }, + ] + request, metadata = self._interceptor.pre_list_debuggees(request, metadata) + pb_request = debugger.ListDebuggeesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.ListDebuggeesResponse() + pb_resp = debugger.ListDebuggeesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_debuggees(resp) + return resp + + class _SetBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("SetBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "breakpoint" : {}, "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.SetBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.SetBreakpointResponse: + r"""Call the set breakpoint method over HTTP. + + Args: + request (~.debugger.SetBreakpointRequest): + The request object. Request to set a breakpoint + 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: + ~.debugger.SetBreakpointResponse: + Response for setting a breakpoint. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/set', + 'body': 'breakpoint', + }, + ] + request, metadata = self._interceptor.pre_set_breakpoint(request, metadata) + pb_request = debugger.SetBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.SetBreakpointResponse() + pb_resp = debugger.SetBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_set_breakpoint(resp) + return resp + + @property + def delete_breakpoint(self) -> Callable[ + [debugger.DeleteBreakpointRequest], + empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_breakpoint(self) -> Callable[ + [debugger.GetBreakpointRequest], + debugger.GetBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_breakpoints(self) -> Callable[ + [debugger.ListBreakpointsRequest], + debugger.ListBreakpointsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListBreakpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_debuggees(self) -> Callable[ + [debugger.ListDebuggeesRequest], + debugger.ListDebuggeesResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListDebuggees(self._session, self._host, self._interceptor) # type: ignore + + @property + def set_breakpoint(self) -> Callable[ + [debugger.SetBreakpointRequest], + debugger.SetBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._SetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'Debugger2RestTransport', +) 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..9791b6c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py @@ -0,0 +1,68 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..2ed0286 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py @@ -0,0 +1,176 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +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: data.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: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + wait_token: str = proto.Field( + proto.STRING, + number=2, + ) + success_on_timeout: bool = proto.Field( + proto.BOOL, + number=3, + ) + + +class ListActiveBreakpointsResponse(proto.Message): + r"""Response for listing active breakpoints. + + Attributes: + breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + next_wait_token: str = proto.Field( + proto.STRING, + number=2, + ) + wait_expired: bool = 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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_: data.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..42e4206 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py @@ -0,0 +1,681 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +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 (MutableSequence[str]): + Optional parameters to be embedded into the + message. + """ + + format_: str = proto.Field( + proto.STRING, + number=1, + ) + parameters: MutableSequence[str] = 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. + + Values: + UNSPECIFIED (0): + Status doesn't refer to any particular input. + BREAKPOINT_SOURCE_LOCATION (3): + Status applies to the breakpoint and is + related to its location. + BREAKPOINT_CONDITION (4): + Status applies to the breakpoint and is + related to its condition. + BREAKPOINT_EXPRESSION (7): + Status applies to the breakpoint and is + related to its expressions. + BREAKPOINT_AGE (8): + Status applies to the breakpoint and is + related to its age. + VARIABLE_NAME (5): + Status applies to the entire variable. + VARIABLE_VALUE (6): + Status applies to variable value (variable + name is valid). + """ + UNSPECIFIED = 0 + BREAKPOINT_SOURCE_LOCATION = 3 + BREAKPOINT_CONDITION = 4 + BREAKPOINT_EXPRESSION = 7 + BREAKPOINT_AGE = 8 + VARIABLE_NAME = 5 + VARIABLE_VALUE = 6 + + is_error: bool = proto.Field( + proto.BOOL, + number=1, + ) + refers_to: Reference = proto.Field( + proto.ENUM, + number=2, + enum=Reference, + ) + description: 'FormatMessage' = 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: str = proto.Field( + proto.STRING, + number=1, + ) + line: int = proto.Field( + proto.INT32, + number=2, + ) + column: int = 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 (MutableSequence[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: str = proto.Field( + proto.STRING, + number=1, + ) + value: str = proto.Field( + proto.STRING, + number=2, + ) + type_: str = proto.Field( + proto.STRING, + number=6, + ) + members: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='Variable', + ) + var_table_index: wrappers_pb2.Int32Value = proto.Field( + proto.MESSAGE, + number=4, + message=wrappers_pb2.Int32Value, + ) + status: 'StatusMessage' = 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 (MutableSequence[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_ (MutableSequence[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: str = proto.Field( + proto.STRING, + number=1, + ) + location: 'SourceLocation' = proto.Field( + proto.MESSAGE, + number=2, + message='SourceLocation', + ) + arguments: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='Variable', + ) + locals_: MutableSequence['Variable'] = 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 (MutableSequence[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 (MutableSequence[google.cloud.debugger_v2.types.StackFrame]): + The stack at breakpoint time, where stack_frames[0] + represents the most recently entered function. + evaluated_expressions (MutableSequence[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 (MutableSequence[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 (MutableMapping[str, str]): + 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. + + Values: + CAPTURE (0): + Capture stack frame and variables and update + the breakpoint. The data is only captured once. + After that the breakpoint is set in a final + state. + LOG (1): + Log each breakpoint hit. The breakpoint + remains active until deleted or expired. + """ + CAPTURE = 0 + LOG = 1 + + class LogLevel(proto.Enum): + r"""Log severity levels. + + Values: + INFO (0): + Information log message. + WARNING (1): + Warning log message. + ERROR (2): + Error log message. + """ + INFO = 0 + WARNING = 1 + ERROR = 2 + + id: str = proto.Field( + proto.STRING, + number=1, + ) + action: Action = proto.Field( + proto.ENUM, + number=13, + enum=Action, + ) + location: 'SourceLocation' = proto.Field( + proto.MESSAGE, + number=2, + message='SourceLocation', + ) + condition: str = proto.Field( + proto.STRING, + number=3, + ) + expressions: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=4, + ) + log_message_format: str = proto.Field( + proto.STRING, + number=14, + ) + log_level: LogLevel = proto.Field( + proto.ENUM, + number=15, + enum=LogLevel, + ) + is_final_state: bool = proto.Field( + proto.BOOL, + number=5, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=11, + message=timestamp_pb2.Timestamp, + ) + final_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=12, + message=timestamp_pb2.Timestamp, + ) + user_email: str = proto.Field( + proto.STRING, + number=16, + ) + status: 'StatusMessage' = proto.Field( + proto.MESSAGE, + number=10, + message='StatusMessage', + ) + stack_frames: MutableSequence['StackFrame'] = proto.RepeatedField( + proto.MESSAGE, + number=7, + message='StackFrame', + ) + evaluated_expressions: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=8, + message='Variable', + ) + variable_table: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=9, + message='Variable', + ) + labels: MutableMapping[str, str] = 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 (MutableSequence[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 (MutableSequence[google.devtools.source.v1.source_context_pb2.ExtendedSourceContext]): + References to the locations and revisions of + the source code used in the deployed + application. + labels (MutableMapping[str, str]): + A set of custom debuggee properties, + populated by the agent, to be displayed to the + user. + """ + + id: str = proto.Field( + proto.STRING, + number=1, + ) + project: str = proto.Field( + proto.STRING, + number=2, + ) + uniquifier: str = proto.Field( + proto.STRING, + number=3, + ) + description: str = proto.Field( + proto.STRING, + number=4, + ) + is_inactive: bool = proto.Field( + proto.BOOL, + number=5, + ) + agent_version: str = proto.Field( + proto.STRING, + number=6, + ) + is_disabled: bool = proto.Field( + proto.BOOL, + number=7, + ) + status: 'StatusMessage' = proto.Field( + proto.MESSAGE, + number=8, + message='StatusMessage', + ) + source_contexts: MutableSequence[source_context_pb2.SourceContext] = proto.RepeatedField( + proto.MESSAGE, + number=9, + message=source_context_pb2.SourceContext, + ) + ext_source_contexts: MutableSequence[source_context_pb2.ExtendedSourceContext] = proto.RepeatedField( + proto.MESSAGE, + number=13, + message=source_context_pb2.ExtendedSourceContext, + ) + labels: MutableMapping[str, str] = 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..0c2fa0a --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py @@ -0,0 +1,315 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_: data.Breakpoint = proto.Field( + proto.MESSAGE, + number=2, + message=data.Breakpoint, + ) + client_version: str = 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_: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_id: str = proto.Field( + proto.STRING, + number=2, + ) + client_version: str = 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_: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_id: str = proto.Field( + proto.STRING, + number=2, + ) + client_version: str = 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: data.Breakpoint.Action = proto.Field( + proto.ENUM, + number=1, + enum=data.Breakpoint.Action, + ) + + debuggee_id: str = proto.Field( + proto.STRING, + number=1, + ) + include_all_users: bool = proto.Field( + proto.BOOL, + number=2, + ) + include_inactive: bool = proto.Field( + proto.BOOL, + number=3, + ) + action: BreakpointActionValue = proto.Field( + proto.MESSAGE, + number=4, + message=BreakpointActionValue, + ) + strip_results: bool = proto.Field( + proto.BOOL, + number=5, + ) + wait_token: str = proto.Field( + proto.STRING, + number=6, + ) + client_version: str = proto.Field( + proto.STRING, + number=8, + ) + + +class ListBreakpointsResponse(proto.Message): + r"""Response for listing breakpoints. + + Attributes: + breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + next_wait_token: str = 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: str = proto.Field( + proto.STRING, + number=2, + ) + include_inactive: bool = proto.Field( + proto.BOOL, + number=3, + ) + client_version: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ListDebuggeesResponse(proto.Message): + r"""Response for listing debuggees. + + Attributes: + debuggees (MutableSequence[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: MutableSequence[data.Debuggee] = 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..574c5ae --- /dev/null +++ b/owl-bot-staging/v2/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +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..02ef930 --- /dev/null +++ b/owl-bot-staging/v2/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +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") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/debugger_v2/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +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=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + 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=DEFAULT_PYTHON_VERSION) +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", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py new file mode 100644 index 0000000..24f6ea0 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListActiveBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py new file mode 100644 index 0000000..67c27c7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListActiveBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py new file mode 100644 index 0000000..b0ac801 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDebuggee +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = await client.register_debuggee(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py new file mode 100644 index 0000000..99f6287 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDebuggee +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = client.register_debuggee(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py new file mode 100644 index 0000000..e74e3e7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateActiveBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py new file mode 100644 index 0000000..10a9948 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateActiveBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py new file mode 100644 index 0000000..b445c89 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + await client.delete_breakpoint(request=request) + + +# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py new file mode 100644 index 0000000..01599f2 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + client.delete_breakpoint(request=request) + + +# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py new file mode 100644 index 0000000..7074dcf --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.get_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py new file mode 100644 index 0000000..3f7ebd0 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.get_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py new file mode 100644 index 0000000..816dd2b --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py new file mode 100644 index 0000000..4f65108 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py new file mode 100644 index 0000000..fda422c --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListDebuggees +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_debuggees(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py new file mode 100644 index 0000000..246e83f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListDebuggees +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_debuggees(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py new file mode 100644 index 0000000..6267555 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.set_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py new file mode 100644 index 0000000..22b41d7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.set_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json new file mode 100644 index 0000000..ab6c88f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json @@ -0,0 +1,1369 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.devtools.clouddebugger.v2", + "version": "v2" + } + ], + "language": "PYTHON", + "name": "google-cloud-debugger-client", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.list_active_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "ListActiveBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", + "shortName": "list_active_breakpoints" + }, + "description": "Sample for ListActiveBreakpoints", + "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.list_active_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "ListActiveBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", + "shortName": "list_active_breakpoints" + }, + "description": "Sample for ListActiveBreakpoints", + "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.register_debuggee", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "RegisterDebuggee" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" + }, + { + "name": "debuggee", + "type": "google.cloud.debugger_v2.types.Debuggee" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", + "shortName": "register_debuggee" + }, + "description": "Sample for RegisterDebuggee", + "file": "clouddebugger_v2_generated_controller2_register_debuggee_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_register_debuggee_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.register_debuggee", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "RegisterDebuggee" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" + }, + { + "name": "debuggee", + "type": "google.cloud.debugger_v2.types.Debuggee" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", + "shortName": "register_debuggee" + }, + "description": "Sample for RegisterDebuggee", + "file": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.update_active_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "UpdateActiveBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", + "shortName": "update_active_breakpoint" + }, + "description": "Sample for UpdateActiveBreakpoint", + "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.update_active_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "UpdateActiveBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", + "shortName": "update_active_breakpoint" + }, + "description": "Sample for UpdateActiveBreakpoint", + "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.delete_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "DeleteBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_breakpoint" + }, + "description": "Sample for DeleteBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.delete_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "DeleteBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_breakpoint" + }, + "description": "Sample for DeleteBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.get_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "GetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", + "shortName": "get_breakpoint" + }, + "description": "Sample for GetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_async", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.get_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "GetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", + "shortName": "get_breakpoint" + }, + "description": "Sample for GetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", + "shortName": "list_breakpoints" + }, + "description": "Sample for ListBreakpoints", + "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.list_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", + "shortName": "list_breakpoints" + }, + "description": "Sample for ListBreakpoints", + "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_debuggees", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListDebuggees" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" + }, + { + "name": "project", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", + "shortName": "list_debuggees" + }, + "description": "Sample for ListDebuggees", + "file": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.list_debuggees", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListDebuggees" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" + }, + { + "name": "project", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", + "shortName": "list_debuggees" + }, + "description": "Sample for ListDebuggees", + "file": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.set_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "SetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", + "shortName": "set_breakpoint" + }, + "description": "Sample for SetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.set_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "SetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", + "shortName": "set_breakpoint" + }, + "description": "Sample for SetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py" + } + ] +} 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..9802c14 --- /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 2022 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..4295418 --- /dev/null +++ b/owl-bot-staging/v2/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-debugger-client' + + +description = "Google Cloud Debugger Client API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/debugger/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-debugger-client" + +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() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v2/testing/constraints-3.10.txt b/owl-bot-staging/v2/testing/constraints-3.10.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.11.txt b/owl-bot-staging/v2/testing/constraints-3.11.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.12.txt b/owl-bot-staging/v2/testing/constraints-3.12.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.7.txt b/owl-bot-staging/v2/testing/constraints-3.7.txt new file mode 100644 index 0000000..6c44adf --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v2/testing/constraints-3.8.txt b/owl-bot-staging/v2/testing/constraints-3.8.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.9.txt b/owl-bot-staging/v2/testing/constraints-3.9.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..5058381 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py @@ -0,0 +1,2551 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +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,transport_name", [ + (Controller2Client, "grpc"), + (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), +]) +def test_controller2_client_from_service_account_info(client_class, transport_name): + 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, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.Controller2GrpcTransport, "grpc"), + (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Controller2RestTransport, "rest"), +]) +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,transport_name", [ + (Controller2Client, "grpc"), + (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), +]) +def test_controller2_client_from_service_account_file(client_class, transport_name): + 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", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +def test_controller2_client_get_transport_class(): + transport = Controller2Client.get_transport_class() + available_transports = [ + transports.Controller2GrpcTransport, + transports.Controller2RestTransport, + ] + 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"), + (Controller2Client, transports.Controller2RestTransport, "rest"), +]) +@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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + 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=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@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"), + (Controller2Client, transports.Controller2RestTransport, "rest", "true"), + (Controller2Client, transports.Controller2RestTransport, "rest", "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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + +@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"), + (Controller2Client, transports.Controller2RestTransport, "rest"), +]) +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, + api_audience=None, + ) + +@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), + (Controller2Client, transports.Controller2RestTransport, "rest", None), +]) +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, + api_audience=None, + ) + +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, + api_audience=None, + ) + + +@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, + api_audience=None, + ) + + # 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_field_headers(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.ListActiveBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # 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: + call.return_value = controller.ListActiveBreakpointsResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_active_breakpoints_field_headers_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.ListActiveBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # 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: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.UpdateActiveBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint.id = 'id_value' + + # 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: + call.return_value = controller.UpdateActiveBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_active_breakpoint_field_headers_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.UpdateActiveBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint.id = 'id_value' + + # 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: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', + ) in kw['metadata'] + + +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'), + ) + + +@pytest.mark.parametrize("request_type", [ + controller.RegisterDebuggeeRequest, + dict, +]) +def test_register_debuggee_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.register_debuggee(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.RegisterDebuggeeResponse) + + +def test_register_debuggee_rest_required_fields(request_type=controller.RegisterDebuggeeRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.register_debuggee(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_register_debuggee_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.register_debuggee._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("debuggee", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_register_debuggee_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_register_debuggee") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_register_debuggee") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.RegisterDebuggeeRequest.pb(controller.RegisterDebuggeeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.RegisterDebuggeeResponse.to_json(controller.RegisterDebuggeeResponse()) + + request = controller.RegisterDebuggeeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.RegisterDebuggeeResponse() + + client.register_debuggee(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_register_debuggee_rest_bad_request(transport: str = 'rest', request_type=controller.RegisterDebuggeeRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.register_debuggee(request) + + +def test_register_debuggee_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + debuggee=data.Debuggee(id='id_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.register_debuggee(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/register" % client.transport._host, args[1]) + + +def test_register_debuggee_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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'), + ) + + +def test_register_debuggee_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + controller.ListActiveBreakpointsRequest, + dict, +]) +def test_list_active_breakpoints_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse( + next_wait_token='next_wait_token_value', + wait_expired=True, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_active_breakpoints(request) + + # 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_rest_required_fields(request_type=controller.ListActiveBreakpointsRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("success_on_timeout", "wait_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_active_breakpoints(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_active_breakpoints_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_active_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == (set(("successOnTimeout", "waitToken", )) & set(("debuggeeId", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_active_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_list_active_breakpoints") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_list_active_breakpoints") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.ListActiveBreakpointsRequest.pb(controller.ListActiveBreakpointsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.ListActiveBreakpointsResponse.to_json(controller.ListActiveBreakpointsResponse()) + + request = controller.ListActiveBreakpointsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.ListActiveBreakpointsResponse() + + client.list_active_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_active_breakpoints_rest_bad_request(transport: str = 'rest', request_type=controller.ListActiveBreakpointsRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_active_breakpoints(request) + + +def test_list_active_breakpoints_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_active_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) + + +def test_list_active_breakpoints_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_active_breakpoints_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + controller.UpdateActiveBreakpointRequest, + dict, +]) +def test_update_active_breakpoint_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_active_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.UpdateActiveBreakpointResponse) + + +def test_update_active_breakpoint_rest_required_fields(request_type=controller.UpdateActiveBreakpointRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "put", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_active_breakpoint(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_active_breakpoint_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_active_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("debuggeeId", "breakpoint", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_active_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_update_active_breakpoint") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_update_active_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.UpdateActiveBreakpointRequest.pb(controller.UpdateActiveBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.UpdateActiveBreakpointResponse.to_json(controller.UpdateActiveBreakpointResponse()) + + request = controller.UpdateActiveBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.UpdateActiveBreakpointResponse() + + client.update_active_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_active_breakpoint_rest_bad_request(transport: str = 'rest', request_type=controller.UpdateActiveBreakpointRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_active_breakpoint(request) + + +def test_update_active_breakpoint_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_active_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}" % client.transport._host, args[1]) + + +def test_update_active_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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'), + ) + + +def test_update_active_breakpoint_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +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, + transports.Controller2RestTransport, +]) +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() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = Controller2Client.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +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() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +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", + [ + transports.Controller2GrpcTransport, + transports.Controller2GrpcAsyncIOTransport, + transports.Controller2RestTransport, + ], +) +def test_controller2_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@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_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.Controller2RestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_controller2_host_no_port(transport_name): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_controller2_host_with_port(transport_name): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_controller2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Controller2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Controller2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.register_debuggee._session + session2 = client2.transport.register_debuggee._session + assert session1 != session2 + session1 = client1.transport.list_active_breakpoints._session + session2 = client2.transport.list_active_breakpoints._session + assert session1 != session2 + session1 = client1.transport.update_active_breakpoint._session + session2 = client2.transport.update_active_breakpoint._session + assert session1 != session2 +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 = { + "rest": "_session", + "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 = [ + 'rest', + '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, + api_audience=None, + ) 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..ad07b63 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py @@ -0,0 +1,3628 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +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,transport_name", [ + (Debugger2Client, "grpc"), + (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), +]) +def test_debugger2_client_from_service_account_info(client_class, transport_name): + 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, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.Debugger2GrpcTransport, "grpc"), + (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Debugger2RestTransport, "rest"), +]) +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,transport_name", [ + (Debugger2Client, "grpc"), + (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), +]) +def test_debugger2_client_from_service_account_file(client_class, transport_name): + 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", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +def test_debugger2_client_get_transport_class(): + transport = Debugger2Client.get_transport_class() + available_transports = [ + transports.Debugger2GrpcTransport, + transports.Debugger2RestTransport, + ] + 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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), +]) +@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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + 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=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "true"), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + +@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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), +]) +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, + api_audience=None, + ) + +@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), + (Debugger2Client, transports.Debugger2RestTransport, "rest", None), +]) +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, + api_audience=None, + ) + +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, + api_audience=None, + ) + + +@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, + api_audience=None, + ) + + # 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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.SetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + call.return_value = debugger.SetBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_set_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.SetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.GetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + call.return_value = debugger.GetBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.GetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.DeleteBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + call.return_value = None + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.DeleteBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.ListBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + call.return_value = debugger.ListBreakpointsResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_breakpoints_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.ListBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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', + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.SetBreakpointRequest, + dict, +]) +def test_set_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.set_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.SetBreakpointResponse) + + +def test_set_breakpoint_rest_required_fields(request_type=debugger.SetBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("breakpoint_", "client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.set_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_set_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.set_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("breakpoint", "clientVersion", )) & set(("debuggeeId", "breakpoint", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_set_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_set_breakpoint") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_set_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.SetBreakpointRequest.pb(debugger.SetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.SetBreakpointResponse.to_json(debugger.SetBreakpointResponse()) + + request = debugger.SetBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.SetBreakpointResponse() + + client.set_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_set_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.SetBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.set_breakpoint(request) + + +def test_set_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.set_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/set" % client.transport._host, args[1]) + + +def test_set_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_set_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.GetBreakpointRequest, + dict, +]) +def test_get_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.GetBreakpointResponse) + + +def test_get_breakpoint_rest_required_fields(request_type=debugger.GetBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["breakpointId"] = 'breakpoint_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == 'breakpoint_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_get_breakpoint") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_get_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.GetBreakpointRequest.pb(debugger.GetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.GetBreakpointResponse.to_json(debugger.GetBreakpointResponse()) + + request = debugger.GetBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.GetBreakpointResponse() + + client.get_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.GetBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_breakpoint(request) + + +def test_get_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) + + +def test_get_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_get_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.DeleteBreakpointRequest, + dict, +]) +def test_delete_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_breakpoint(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_breakpoint_rest_required_fields(request_type=debugger.DeleteBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["breakpointId"] = 'breakpoint_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == 'breakpoint_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_delete_breakpoint") as pre: + pre.assert_not_called() + pb_message = debugger.DeleteBreakpointRequest.pb(debugger.DeleteBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = debugger.DeleteBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_delete_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.DeleteBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_breakpoint(request) + + +def test_delete_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) + + +def test_delete_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_delete_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.ListBreakpointsRequest, + dict, +]) +def test_list_breakpoints_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse( + next_wait_token='next_wait_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_breakpoints(request) + + # 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_rest_required_fields(request_type=debugger.ListBreakpointsRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("action", "client_version", "include_all_users", "include_inactive", "strip_results", "wait_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_breakpoints(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_breakpoints_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == (set(("action", "clientVersion", "includeAllUsers", "includeInactive", "stripResults", "waitToken", )) & set(("debuggeeId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_list_breakpoints") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_breakpoints") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListBreakpointsRequest.pb(debugger.ListBreakpointsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListBreakpointsResponse.to_json(debugger.ListBreakpointsResponse()) + + request = debugger.ListBreakpointsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListBreakpointsResponse() + + client.list_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_breakpoints_rest_bad_request(transport: str = 'rest', request_type=debugger.ListBreakpointsRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_breakpoints(request) + + +def test_list_breakpoints_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) + + +def test_list_breakpoints_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_breakpoints_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.ListDebuggeesRequest, + dict, +]) +def test_list_debuggees_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_debuggees(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.ListDebuggeesResponse) + + +def test_list_debuggees_rest_required_fields(request_type=debugger.ListDebuggeesRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["project"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "project" not in jsonified_request + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "project" in jsonified_request + assert jsonified_request["project"] == request_init["project"] + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["project"] = 'project_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", "include_inactive", "project", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "project" in jsonified_request + assert jsonified_request["project"] == 'project_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_debuggees(request) + + expected_params = [ + ( + "project", + "", + ), + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_debuggees_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_debuggees._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", "includeInactive", "project", )) & set(("project", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_debuggees_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_list_debuggees") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_debuggees") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListDebuggeesRequest.pb(debugger.ListDebuggeesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListDebuggeesResponse.to_json(debugger.ListDebuggeesResponse()) + + request = debugger.ListDebuggeesRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListDebuggeesResponse() + + client.list_debuggees(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_debuggees_rest_bad_request(transport: str = 'rest', request_type=debugger.ListDebuggeesRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_debuggees(request) + + +def test_list_debuggees_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + project='project_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_debuggees(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees" % client.transport._host, args[1]) + + +def test_list_debuggees_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_debuggees_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +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, + transports.Debugger2RestTransport, +]) +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() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = Debugger2Client.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +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() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +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", + [ + transports.Debugger2GrpcTransport, + transports.Debugger2GrpcAsyncIOTransport, + transports.Debugger2RestTransport, + ], +) +def test_debugger2_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@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_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.Debugger2RestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_debugger2_host_no_port(transport_name): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_debugger2_host_with_port(transport_name): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_debugger2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Debugger2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Debugger2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.set_breakpoint._session + session2 = client2.transport.set_breakpoint._session + assert session1 != session2 + session1 = client1.transport.get_breakpoint._session + session2 = client2.transport.get_breakpoint._session + assert session1 != session2 + session1 = client1.transport.delete_breakpoint._session + session2 = client2.transport.delete_breakpoint._session + assert session1 != session2 + session1 = client1.transport.list_breakpoints._session + session2 = client2.transport.list_breakpoints._session + assert session1 != session2 + session1 = client1.transport.list_debuggees._session + session2 = client2.transport.list_debuggees._session + assert session1 != session2 +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 = { + "rest": "_session", + "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 = [ + 'rest', + '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, + api_audience=None, + ) From 5d94b719537d3ac3d312c8f8cadb513a95addb2f Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Fri, 24 Feb 2023 02:01:42 +0000 Subject: [PATCH 04/10] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20?= =?UTF-8?q?post-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- .../services/controller2/transports/rest.py | 8 +- .../services/debugger2/transports/rest.py | 12 +- google/cloud/debugger_v2/types/controller.py | 2 + google/cloud/debugger_v2/types/data.py | 2 + google/cloud/debugger_v2/types/debugger.py | 2 + owl-bot-staging/v2/.coveragerc | 13 - owl-bot-staging/v2/.flake8 | 33 - 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 | 6 - owl-bot-staging/v2/docs/index.rst | 7 - .../v2/google/cloud/debugger/__init__.py | 75 - .../v2/google/cloud/debugger/gapic_version.py | 16 - .../v2/google/cloud/debugger/py.typed | 2 - .../v2/google/cloud/debugger_v2/__init__.py | 76 - .../cloud/debugger_v2/gapic_metadata.json | 167 - .../google/cloud/debugger_v2/gapic_version.py | 16 - .../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 | 566 --- .../services/controller2/client.py | 747 ---- .../controller2/transports/__init__.py | 38 - .../services/controller2/transports/base.py | 191 - .../services/controller2/transports/grpc.py | 369 -- .../controller2/transports/grpc_asyncio.py | 368 -- .../services/controller2/transports/rest.py | 554 --- .../services/debugger2/__init__.py | 22 - .../services/debugger2/async_client.py | 806 ---- .../debugger_v2/services/debugger2/client.py | 973 ----- .../services/debugger2/transports/__init__.py | 38 - .../services/debugger2/transports/base.py | 234 -- .../services/debugger2/transports/grpc.py | 381 -- .../debugger2/transports/grpc_asyncio.py | 380 -- .../services/debugger2/transports/rest.py | 730 ---- .../cloud/debugger_v2/types/__init__.py | 68 - .../cloud/debugger_v2/types/controller.py | 176 - .../v2/google/cloud/debugger_v2/types/data.py | 681 ---- .../cloud/debugger_v2/types/debugger.py | 315 -- owl-bot-staging/v2/mypy.ini | 3 - owl-bot-staging/v2/noxfile.py | 184 - ...ntroller2_list_active_breakpoints_async.py | 52 - ...ontroller2_list_active_breakpoints_sync.py | 52 - ...ted_controller2_register_debuggee_async.py | 51 - ...ated_controller2_register_debuggee_sync.py | 51 - ...troller2_update_active_breakpoint_async.py | 52 - ...ntroller2_update_active_breakpoint_sync.py | 52 - ...rated_debugger2_delete_breakpoint_async.py | 52 - ...erated_debugger2_delete_breakpoint_sync.py | 52 - ...enerated_debugger2_get_breakpoint_async.py | 54 - ...generated_debugger2_get_breakpoint_sync.py | 54 - ...erated_debugger2_list_breakpoints_async.py | 53 - ...nerated_debugger2_list_breakpoints_sync.py | 53 - ...enerated_debugger2_list_debuggees_async.py | 53 - ...generated_debugger2_list_debuggees_sync.py | 53 - ...enerated_debugger2_set_breakpoint_async.py | 53 - ...generated_debugger2_set_breakpoint_sync.py | 53 - ...data_google.devtools.clouddebugger.v2.json | 1369 ------- .../v2/scripts/fixup_debugger_v2_keywords.py | 183 - owl-bot-staging/v2/setup.py | 90 - .../v2/testing/constraints-3.10.txt | 6 - .../v2/testing/constraints-3.11.txt | 6 - .../v2/testing/constraints-3.12.txt | 6 - .../v2/testing/constraints-3.7.txt | 9 - .../v2/testing/constraints-3.8.txt | 6 - .../v2/testing/constraints-3.9.txt | 6 - 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 | 2551 ------------ .../unit/gapic/debugger_v2/test_debugger2.py | 3628 ----------------- 76 files changed, 16 insertions(+), 17494 deletions(-) delete mode 100644 owl-bot-staging/v2/.coveragerc delete mode 100644 owl-bot-staging/v2/.flake8 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/gapic_version.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/gapic_version.py 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/controller2/transports/rest.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/services/debugger2/transports/rest.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/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json 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/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.9.txt 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/transports/rest.py b/google/cloud/debugger_v2/services/controller2/transports/rest.py index cc3b1b0..fd102b7 100644 --- a/google/cloud/debugger_v2/services/controller2/transports/rest.py +++ b/google/cloud/debugger_v2/services/controller2/transports/rest.py @@ -17,7 +17,7 @@ import dataclasses import json # type: ignore import re -from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union import warnings from google.api_core import gapic_v1, path_template, rest_helpers, rest_streaming @@ -284,7 +284,7 @@ class _ListActiveBreakpoints(Controller2RestStub): def __hash__(self): return hash("ListActiveBreakpoints") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): @@ -374,7 +374,7 @@ class _RegisterDebuggee(Controller2RestStub): def __hash__(self): return hash("RegisterDebuggee") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): @@ -471,7 +471,7 @@ class _UpdateActiveBreakpoint(Controller2RestStub): def __hash__(self): return hash("UpdateActiveBreakpoint") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = {} + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {} @classmethod def _get_unset_required_fields(cls, message_dict): diff --git a/google/cloud/debugger_v2/services/debugger2/transports/rest.py b/google/cloud/debugger_v2/services/debugger2/transports/rest.py index 3347e07..e2cebab 100644 --- a/google/cloud/debugger_v2/services/debugger2/transports/rest.py +++ b/google/cloud/debugger_v2/services/debugger2/transports/rest.py @@ -17,7 +17,7 @@ import dataclasses import json # type: ignore import re -from typing import Callable, Dict, List, Optional, Sequence, Tuple, Union +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union import warnings from google.api_core import gapic_v1, path_template, rest_helpers, rest_streaming @@ -324,7 +324,7 @@ class _DeleteBreakpoint(Debugger2RestStub): def __hash__(self): return hash("DeleteBreakpoint") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { "clientVersion": "", } @@ -402,7 +402,7 @@ class _GetBreakpoint(Debugger2RestStub): def __hash__(self): return hash("GetBreakpoint") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { "clientVersion": "", } @@ -494,7 +494,7 @@ class _ListBreakpoints(Debugger2RestStub): def __hash__(self): return hash("ListBreakpoints") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { "clientVersion": "", } @@ -584,7 +584,7 @@ class _ListDebuggees(Debugger2RestStub): def __hash__(self): return hash("ListDebuggees") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { "project": "", "clientVersion": "", } @@ -673,7 +673,7 @@ class _SetBreakpoint(Debugger2RestStub): def __hash__(self): return hash("SetBreakpoint") - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, str] = { + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { "breakpoint": {}, "clientVersion": "", } diff --git a/google/cloud/debugger_v2/types/controller.py b/google/cloud/debugger_v2/types/controller.py index 6740f2f..0b1880c 100644 --- a/google/cloud/debugger_v2/types/controller.py +++ b/google/cloud/debugger_v2/types/controller.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/google/cloud/debugger_v2/types/data.py b/google/cloud/debugger_v2/types/data.py index 7887bfc..4118ed0 100644 --- a/google/cloud/debugger_v2/types/data.py +++ b/google/cloud/debugger_v2/types/data.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence from google.cloud.source_context_v1.types import ( diff --git a/google/cloud/debugger_v2/types/debugger.py b/google/cloud/debugger_v2/types/debugger.py index d63fcde..7711a81 100644 --- a/google/cloud/debugger_v2/types/debugger.py +++ b/google/cloud/debugger_v2/types/debugger.py @@ -13,6 +13,8 @@ # See the License for the specific language governing permissions and # limitations under the License. # +from __future__ import annotations + from typing import MutableMapping, MutableSequence import proto # type: ignore diff --git a/owl-bot-staging/v2/.coveragerc b/owl-bot-staging/v2/.coveragerc deleted file mode 100644 index 9620812..0000000 --- a/owl-bot-staging/v2/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/debugger/__init__.py - google/cloud/debugger/gapic_version.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ diff --git a/owl-bot-staging/v2/.flake8 b/owl-bot-staging/v2/.flake8 deleted file mode 100644 index 29227d4..0000000 --- a/owl-bot-staging/v2/.flake8 +++ /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 -# -# https://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. - -# Generated by synthtool. DO NOT EDIT! -[flake8] -ignore = E203, E266, E501, W503 -exclude = - # Exclude generated code. - **/proto/** - **/gapic/** - **/services/** - **/types/** - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py 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 4ad5ea1..0000000 --- a/owl-bot-staging/v2/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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"2022, 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 0106467..0000000 --- a/owl-bot-staging/v2/docs/debugger_v2/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Debugger v2 API -====================================== - -.. automodule:: google.cloud.debugger_v2.types - :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 1228468..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger/__init__.py +++ /dev/null @@ -1,75 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 import gapic_version as package_version - -__version__ = package_version.__version__ - - -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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -__version__ = "0.1.0" # {x-release-please-version} 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 c774017..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py +++ /dev/null @@ -1,76 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 import gapic_version as package_version - -__version__ = package_version.__version__ - - -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 f0d8a90..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json +++ /dev/null @@ -1,167 +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" - ] - } - } - }, - "rest": { - "libraryClient": "Controller2Client", - "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" - ] - } - } - }, - "rest": { - "libraryClient": "Debugger2Client", - "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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -__version__ = "0.1.0" # {x-release-please-version} 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 e8e1c38..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 e010a73..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 aa29878..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py +++ /dev/null @@ -1,566 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 variable 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: Optional[ga_credentials.Credentials] = None, - transport: Union[str, Controller2Transport] = "grpc_asyncio", - client_options: Optional[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: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, - *, - debuggee: Optional[data.Debuggee] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = await client.register_debuggee(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint.id", request.breakpoint.id), - )), - ) - - # 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() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 7330718..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py +++ /dev/null @@ -1,747 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 -from .transports.rest import Controller2RestTransport - - -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 - _transport_registry["rest"] = Controller2RestTransport - - def get_transport_class(cls, - label: Optional[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 variable 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: Optional[Union[str, Controller2Transport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() - client_options = cast(client_options_lib.ClientOptions, client_options) - - 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, - api_audience=client_options.api_audience, - ) - - def register_debuggee(self, - request: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, - *, - debuggee: Optional[data.Debuggee] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = client.register_debuggee(request=request) - - # Handle the response - print(response) - - 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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_active_breakpoint(self, - request: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint.id", request.breakpoint.id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "Controller2Client": - 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() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 0381ff4..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -from .rest import Controller2RestTransport -from .rest import Controller2RestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] -_transport_registry['grpc'] = Controller2GrpcTransport -_transport_registry['grpc_asyncio'] = Controller2GrpcAsyncIOTransport -_transport_registry['rest'] = Controller2RestTransport - -__all__ = ( - 'Controller2Transport', - 'Controller2GrpcTransport', - 'Controller2GrpcAsyncIOTransport', - 'Controller2RestTransport', - 'Controller2RestInterceptor', -) 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 8e480a6..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py +++ /dev/null @@ -1,191 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -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: Optional[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, - api_audience: Optional[str] = None, - **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. - """ - - 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) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # 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 - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - 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() - - @property - def kind(self) -> str: - 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 09e2efa..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py +++ /dev/null @@ -1,369 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[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() - - @property - def kind(self) -> str: - return "grpc" - - -__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 ae65db1..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py +++ /dev/null @@ -1,368 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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/controller2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py deleted file mode 100644 index 3bd7006..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py +++ /dev/null @@ -1,554 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -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 .base import Controller2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class Controller2RestInterceptor: - """Interceptor for Controller2. - - Interceptors are used to manipulate requests, request metadata, and responses - in arbitrary ways. - Example use cases include: - * Logging - * Verifying requests according to service or custom semantics - * Stripping extraneous information from responses - - These use cases and more can be enabled by injecting an - instance of a custom subclass when constructing the Controller2RestTransport. - - .. code-block:: python - class MyCustomController2Interceptor(Controller2RestInterceptor): - def pre_list_active_breakpoints(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_active_breakpoints(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_register_debuggee(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_register_debuggee(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_active_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_active_breakpoint(self, response): - logging.log(f"Received response: {response}") - return response - - transport = Controller2RestTransport(interceptor=MyCustomController2Interceptor()) - client = Controller2Client(transport=transport) - - - """ - def pre_list_active_breakpoints(self, request: controller.ListActiveBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.ListActiveBreakpointsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_active_breakpoints - - Override in a subclass to manipulate the request or metadata - before they are sent to the Controller2 server. - """ - return request, metadata - - def post_list_active_breakpoints(self, response: controller.ListActiveBreakpointsResponse) -> controller.ListActiveBreakpointsResponse: - """Post-rpc interceptor for list_active_breakpoints - - Override in a subclass to manipulate the response - after it is returned by the Controller2 server but before - it is returned to user code. - """ - return response - def pre_register_debuggee(self, request: controller.RegisterDebuggeeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.RegisterDebuggeeRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for register_debuggee - - Override in a subclass to manipulate the request or metadata - before they are sent to the Controller2 server. - """ - return request, metadata - - def post_register_debuggee(self, response: controller.RegisterDebuggeeResponse) -> controller.RegisterDebuggeeResponse: - """Post-rpc interceptor for register_debuggee - - Override in a subclass to manipulate the response - after it is returned by the Controller2 server but before - it is returned to user code. - """ - return response - def pre_update_active_breakpoint(self, request: controller.UpdateActiveBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.UpdateActiveBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for update_active_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Controller2 server. - """ - return request, metadata - - def post_update_active_breakpoint(self, response: controller.UpdateActiveBreakpointResponse) -> controller.UpdateActiveBreakpointResponse: - """Post-rpc interceptor for update_active_breakpoint - - Override in a subclass to manipulate the response - after it is returned by the Controller2 server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class Controller2RestStub: - _session: AuthorizedSession - _host: str - _interceptor: Controller2RestInterceptor - - -class Controller2RestTransport(Controller2Transport): - """REST 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 JSON representations of protocol buffers over HTTP/1.1 - - """ - - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[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, - url_scheme: str = 'https', - interceptor: Optional[Controller2RestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> 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 ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` 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 are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or Controller2RestInterceptor() - self._prep_wrapped_messages(client_info) - - class _ListActiveBreakpoints(Controller2RestStub): - def __hash__(self): - return hash("ListActiveBreakpoints") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.ListActiveBreakpointsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.ListActiveBreakpointsResponse: - r"""Call the list active breakpoints method over HTTP. - - Args: - request (~.controller.ListActiveBreakpointsRequest): - The request object. Request to list active breakpoints. - 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: - ~.controller.ListActiveBreakpointsResponse: - Response for listing active - breakpoints. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints', - }, - ] - request, metadata = self._interceptor.pre_list_active_breakpoints(request, metadata) - pb_request = controller.ListActiveBreakpointsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = controller.ListActiveBreakpointsResponse() - pb_resp = controller.ListActiveBreakpointsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_active_breakpoints(resp) - return resp - - class _RegisterDebuggee(Controller2RestStub): - def __hash__(self): - return hash("RegisterDebuggee") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.RegisterDebuggeeRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.RegisterDebuggeeResponse: - r"""Call the register debuggee method over HTTP. - - Args: - request (~.controller.RegisterDebuggeeRequest): - The request object. Request to register a debuggee. - 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: - ~.controller.RegisterDebuggeeResponse: - Response for registering a debuggee. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v2/controller/debuggees/register', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_register_debuggee(request, metadata) - pb_request = controller.RegisterDebuggeeRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = controller.RegisterDebuggeeResponse() - pb_resp = controller.RegisterDebuggeeResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_register_debuggee(resp) - return resp - - class _UpdateActiveBreakpoint(Controller2RestStub): - def __hash__(self): - return hash("UpdateActiveBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.UpdateActiveBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.UpdateActiveBreakpointResponse: - r"""Call the update active breakpoint method over HTTP. - - Args: - request (~.controller.UpdateActiveBreakpointRequest): - The request object. Request to update an active - breakpoint. - - 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: - ~.controller.UpdateActiveBreakpointResponse: - Response for updating an active - breakpoint. The message is defined to - allow future extensions. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'put', - 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_update_active_breakpoint(request, metadata) - pb_request = controller.UpdateActiveBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = controller.UpdateActiveBreakpointResponse() - pb_resp = controller.UpdateActiveBreakpointResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_update_active_breakpoint(resp) - return resp - - @property - def list_active_breakpoints(self) -> Callable[ - [controller.ListActiveBreakpointsRequest], - controller.ListActiveBreakpointsResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListActiveBreakpoints(self._session, self._host, self._interceptor) # type: ignore - - @property - def register_debuggee(self) -> Callable[ - [controller.RegisterDebuggeeRequest], - controller.RegisterDebuggeeResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._RegisterDebuggee(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_active_breakpoint(self) -> Callable[ - [controller.UpdateActiveBreakpointRequest], - controller.UpdateActiveBreakpointResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._UpdateActiveBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'Controller2RestTransport', -) 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 5d7f609..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 257c378..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py +++ /dev/null @@ -1,806 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 variable 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: Optional[ga_credentials.Credentials] = None, - transport: Union[str, Debugger2Transport] = "grpc_asyncio", - client_options: Optional[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: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.SetBreakpointResponse: - r"""Sets the breakpoint to the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.set_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.GetBreakpointResponse: - r"""Gets breakpoint information. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.get_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # 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: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the breakpoint from the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - await client.delete_breakpoint(request=request) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def list_breakpoints(self, - request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListBreakpointsResponse: - r"""Lists all breakpoints for the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_breakpoints(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, - *, - project: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListDebuggeesResponse: - r"""Lists all the debuggees that the user has access to. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_debuggees(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 7e52f8d..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py +++ /dev/null @@ -1,973 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 -from .transports.rest import Debugger2RestTransport - - -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 - _transport_registry["rest"] = Debugger2RestTransport - - def get_transport_class(cls, - label: Optional[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 variable 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: Optional[Union[str, Debugger2Transport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() - client_options = cast(client_options_lib.ClientOptions, client_options) - - 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, - api_audience=client_options.api_audience, - ) - - def set_breakpoint(self, - request: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.SetBreakpointResponse: - r"""Sets the breakpoint to the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.set_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_breakpoint(self, - request: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.GetBreakpointResponse: - r"""Gets breakpoint information. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.get_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_breakpoint(self, - request: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the breakpoint from the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - client.delete_breakpoint(request=request) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def list_breakpoints(self, - request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListBreakpointsResponse: - r"""Lists all breakpoints for the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_breakpoints(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_debuggees(self, - request: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, - *, - project: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListDebuggeesResponse: - r"""Lists all the debuggees that the user has access to. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_debuggees(request=request) - - # Handle the response - print(response) - - 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) -> "Debugger2Client": - 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() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 cd9dd46..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -from .rest import Debugger2RestTransport -from .rest import Debugger2RestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] -_transport_registry['grpc'] = Debugger2GrpcTransport -_transport_registry['grpc_asyncio'] = Debugger2GrpcAsyncIOTransport -_transport_registry['rest'] = Debugger2RestTransport - -__all__ = ( - 'Debugger2Transport', - 'Debugger2GrpcTransport', - 'Debugger2GrpcAsyncIOTransport', - 'Debugger2RestTransport', - 'Debugger2RestInterceptor', -) 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 c4afc0c..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py +++ /dev/null @@ -1,234 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -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: Optional[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, - api_audience: Optional[str] = None, - **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. - """ - - 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) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # 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 - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - 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() - - @property - def kind(self) -> str: - 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 fbb3374..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py +++ /dev/null @@ -1,381 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[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() - - @property - def kind(self) -> str: - return "grpc" - - -__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 eb6eadc..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py +++ /dev/null @@ -1,380 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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/services/debugger2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py deleted file mode 100644 index f2373b6..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py +++ /dev/null @@ -1,730 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -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 debugger -from google.protobuf import empty_pb2 # type: ignore - -from .base import Debugger2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class Debugger2RestInterceptor: - """Interceptor for Debugger2. - - Interceptors are used to manipulate requests, request metadata, and responses - in arbitrary ways. - Example use cases include: - * Logging - * Verifying requests according to service or custom semantics - * Stripping extraneous information from responses - - These use cases and more can be enabled by injecting an - instance of a custom subclass when constructing the Debugger2RestTransport. - - .. code-block:: python - class MyCustomDebugger2Interceptor(Debugger2RestInterceptor): - def pre_delete_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def pre_get_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_breakpoint(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_breakpoints(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_breakpoints(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_debuggees(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_debuggees(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_set_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_set_breakpoint(self, response): - logging.log(f"Received response: {response}") - return response - - transport = Debugger2RestTransport(interceptor=MyCustomDebugger2Interceptor()) - client = Debugger2Client(transport=transport) - - - """ - def pre_delete_breakpoint(self, request: debugger.DeleteBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.DeleteBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for delete_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def pre_get_breakpoint(self, request: debugger.GetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.GetBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_get_breakpoint(self, response: debugger.GetBreakpointResponse) -> debugger.GetBreakpointResponse: - """Post-rpc interceptor for get_breakpoint - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - def pre_list_breakpoints(self, request: debugger.ListBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListBreakpointsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_breakpoints - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_list_breakpoints(self, response: debugger.ListBreakpointsResponse) -> debugger.ListBreakpointsResponse: - """Post-rpc interceptor for list_breakpoints - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - def pre_list_debuggees(self, request: debugger.ListDebuggeesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListDebuggeesRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_debuggees - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_list_debuggees(self, response: debugger.ListDebuggeesResponse) -> debugger.ListDebuggeesResponse: - """Post-rpc interceptor for list_debuggees - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - def pre_set_breakpoint(self, request: debugger.SetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.SetBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for set_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_set_breakpoint(self, response: debugger.SetBreakpointResponse) -> debugger.SetBreakpointResponse: - """Post-rpc interceptor for set_breakpoint - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class Debugger2RestStub: - _session: AuthorizedSession - _host: str - _interceptor: Debugger2RestInterceptor - - -class Debugger2RestTransport(Debugger2Transport): - """REST 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 JSON representations of protocol buffers over HTTP/1.1 - - """ - - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[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, - url_scheme: str = 'https', - interceptor: Optional[Debugger2RestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> 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 ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` 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 are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or Debugger2RestInterceptor() - self._prep_wrapped_messages(client_info) - - class _DeleteBreakpoint(Debugger2RestStub): - def __hash__(self): - return hash("DeleteBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.DeleteBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ): - r"""Call the delete breakpoint method over HTTP. - - Args: - request (~.debugger.DeleteBreakpointRequest): - The request object. Request to delete a breakpoint. - 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. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', - }, - ] - request, metadata = self._interceptor.pre_delete_breakpoint(request, metadata) - pb_request = debugger.DeleteBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - class _GetBreakpoint(Debugger2RestStub): - def __hash__(self): - return hash("GetBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.GetBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.GetBreakpointResponse: - r"""Call the get breakpoint method over HTTP. - - Args: - request (~.debugger.GetBreakpointRequest): - The request object. Request to get breakpoint - information. - - 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: - ~.debugger.GetBreakpointResponse: - Response for getting breakpoint - information. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', - }, - ] - request, metadata = self._interceptor.pre_get_breakpoint(request, metadata) - pb_request = debugger.GetBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.GetBreakpointResponse() - pb_resp = debugger.GetBreakpointResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_breakpoint(resp) - return resp - - class _ListBreakpoints(Debugger2RestStub): - def __hash__(self): - return hash("ListBreakpoints") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.ListBreakpointsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.ListBreakpointsResponse: - r"""Call the list breakpoints method over HTTP. - - Args: - request (~.debugger.ListBreakpointsRequest): - The request object. Request to list breakpoints. - 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: - ~.debugger.ListBreakpointsResponse: - Response for listing breakpoints. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints', - }, - ] - request, metadata = self._interceptor.pre_list_breakpoints(request, metadata) - pb_request = debugger.ListBreakpointsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.ListBreakpointsResponse() - pb_resp = debugger.ListBreakpointsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_breakpoints(resp) - return resp - - class _ListDebuggees(Debugger2RestStub): - def __hash__(self): - return hash("ListDebuggees") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "project" : "", "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.ListDebuggeesRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.ListDebuggeesResponse: - r"""Call the list debuggees method over HTTP. - - Args: - request (~.debugger.ListDebuggeesRequest): - The request object. Request to list debuggees. - 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: - ~.debugger.ListDebuggeesResponse: - Response for listing debuggees. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees', - }, - ] - request, metadata = self._interceptor.pre_list_debuggees(request, metadata) - pb_request = debugger.ListDebuggeesRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.ListDebuggeesResponse() - pb_resp = debugger.ListDebuggeesResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_debuggees(resp) - return resp - - class _SetBreakpoint(Debugger2RestStub): - def __hash__(self): - return hash("SetBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "breakpoint" : {}, "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.SetBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.SetBreakpointResponse: - r"""Call the set breakpoint method over HTTP. - - Args: - request (~.debugger.SetBreakpointRequest): - The request object. Request to set a breakpoint - 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: - ~.debugger.SetBreakpointResponse: - Response for setting a breakpoint. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/set', - 'body': 'breakpoint', - }, - ] - request, metadata = self._interceptor.pre_set_breakpoint(request, metadata) - pb_request = debugger.SetBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.SetBreakpointResponse() - pb_resp = debugger.SetBreakpointResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_set_breakpoint(resp) - return resp - - @property - def delete_breakpoint(self) -> Callable[ - [debugger.DeleteBreakpointRequest], - empty_pb2.Empty]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._DeleteBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_breakpoint(self) -> Callable[ - [debugger.GetBreakpointRequest], - debugger.GetBreakpointResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._GetBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_breakpoints(self) -> Callable[ - [debugger.ListBreakpointsRequest], - debugger.ListBreakpointsResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListBreakpoints(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_debuggees(self) -> Callable[ - [debugger.ListDebuggeesRequest], - debugger.ListDebuggeesResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListDebuggees(self._session, self._host, self._interceptor) # type: ignore - - @property - def set_breakpoint(self) -> Callable[ - [debugger.SetBreakpointRequest], - debugger.SetBreakpointResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._SetBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'Debugger2RestTransport', -) 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 9791b6c..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py +++ /dev/null @@ -1,68 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 2ed0286..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py +++ /dev/null @@ -1,176 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -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: data.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: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - wait_token: str = proto.Field( - proto.STRING, - number=2, - ) - success_on_timeout: bool = proto.Field( - proto.BOOL, - number=3, - ) - - -class ListActiveBreakpointsResponse(proto.Message): - r"""Response for listing active breakpoints. - - Attributes: - breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - next_wait_token: str = proto.Field( - proto.STRING, - number=2, - ) - wait_expired: bool = 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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_: data.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 42e4206..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py +++ /dev/null @@ -1,681 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -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 (MutableSequence[str]): - Optional parameters to be embedded into the - message. - """ - - format_: str = proto.Field( - proto.STRING, - number=1, - ) - parameters: MutableSequence[str] = 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. - - Values: - UNSPECIFIED (0): - Status doesn't refer to any particular input. - BREAKPOINT_SOURCE_LOCATION (3): - Status applies to the breakpoint and is - related to its location. - BREAKPOINT_CONDITION (4): - Status applies to the breakpoint and is - related to its condition. - BREAKPOINT_EXPRESSION (7): - Status applies to the breakpoint and is - related to its expressions. - BREAKPOINT_AGE (8): - Status applies to the breakpoint and is - related to its age. - VARIABLE_NAME (5): - Status applies to the entire variable. - VARIABLE_VALUE (6): - Status applies to variable value (variable - name is valid). - """ - UNSPECIFIED = 0 - BREAKPOINT_SOURCE_LOCATION = 3 - BREAKPOINT_CONDITION = 4 - BREAKPOINT_EXPRESSION = 7 - BREAKPOINT_AGE = 8 - VARIABLE_NAME = 5 - VARIABLE_VALUE = 6 - - is_error: bool = proto.Field( - proto.BOOL, - number=1, - ) - refers_to: Reference = proto.Field( - proto.ENUM, - number=2, - enum=Reference, - ) - description: 'FormatMessage' = 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: str = proto.Field( - proto.STRING, - number=1, - ) - line: int = proto.Field( - proto.INT32, - number=2, - ) - column: int = 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 (MutableSequence[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: str = proto.Field( - proto.STRING, - number=1, - ) - value: str = proto.Field( - proto.STRING, - number=2, - ) - type_: str = proto.Field( - proto.STRING, - number=6, - ) - members: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Variable', - ) - var_table_index: wrappers_pb2.Int32Value = proto.Field( - proto.MESSAGE, - number=4, - message=wrappers_pb2.Int32Value, - ) - status: 'StatusMessage' = 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 (MutableSequence[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_ (MutableSequence[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: str = proto.Field( - proto.STRING, - number=1, - ) - location: 'SourceLocation' = proto.Field( - proto.MESSAGE, - number=2, - message='SourceLocation', - ) - arguments: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Variable', - ) - locals_: MutableSequence['Variable'] = 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 (MutableSequence[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 (MutableSequence[google.cloud.debugger_v2.types.StackFrame]): - The stack at breakpoint time, where stack_frames[0] - represents the most recently entered function. - evaluated_expressions (MutableSequence[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 (MutableSequence[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 (MutableMapping[str, str]): - 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. - - Values: - CAPTURE (0): - Capture stack frame and variables and update - the breakpoint. The data is only captured once. - After that the breakpoint is set in a final - state. - LOG (1): - Log each breakpoint hit. The breakpoint - remains active until deleted or expired. - """ - CAPTURE = 0 - LOG = 1 - - class LogLevel(proto.Enum): - r"""Log severity levels. - - Values: - INFO (0): - Information log message. - WARNING (1): - Warning log message. - ERROR (2): - Error log message. - """ - INFO = 0 - WARNING = 1 - ERROR = 2 - - id: str = proto.Field( - proto.STRING, - number=1, - ) - action: Action = proto.Field( - proto.ENUM, - number=13, - enum=Action, - ) - location: 'SourceLocation' = proto.Field( - proto.MESSAGE, - number=2, - message='SourceLocation', - ) - condition: str = proto.Field( - proto.STRING, - number=3, - ) - expressions: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=4, - ) - log_message_format: str = proto.Field( - proto.STRING, - number=14, - ) - log_level: LogLevel = proto.Field( - proto.ENUM, - number=15, - enum=LogLevel, - ) - is_final_state: bool = proto.Field( - proto.BOOL, - number=5, - ) - create_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=11, - message=timestamp_pb2.Timestamp, - ) - final_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=12, - message=timestamp_pb2.Timestamp, - ) - user_email: str = proto.Field( - proto.STRING, - number=16, - ) - status: 'StatusMessage' = proto.Field( - proto.MESSAGE, - number=10, - message='StatusMessage', - ) - stack_frames: MutableSequence['StackFrame'] = proto.RepeatedField( - proto.MESSAGE, - number=7, - message='StackFrame', - ) - evaluated_expressions: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=8, - message='Variable', - ) - variable_table: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=9, - message='Variable', - ) - labels: MutableMapping[str, str] = 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 (MutableSequence[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 (MutableSequence[google.devtools.source.v1.source_context_pb2.ExtendedSourceContext]): - References to the locations and revisions of - the source code used in the deployed - application. - labels (MutableMapping[str, str]): - A set of custom debuggee properties, - populated by the agent, to be displayed to the - user. - """ - - id: str = proto.Field( - proto.STRING, - number=1, - ) - project: str = proto.Field( - proto.STRING, - number=2, - ) - uniquifier: str = proto.Field( - proto.STRING, - number=3, - ) - description: str = proto.Field( - proto.STRING, - number=4, - ) - is_inactive: bool = proto.Field( - proto.BOOL, - number=5, - ) - agent_version: str = proto.Field( - proto.STRING, - number=6, - ) - is_disabled: bool = proto.Field( - proto.BOOL, - number=7, - ) - status: 'StatusMessage' = proto.Field( - proto.MESSAGE, - number=8, - message='StatusMessage', - ) - source_contexts: MutableSequence[source_context_pb2.SourceContext] = proto.RepeatedField( - proto.MESSAGE, - number=9, - message=source_context_pb2.SourceContext, - ) - ext_source_contexts: MutableSequence[source_context_pb2.ExtendedSourceContext] = proto.RepeatedField( - proto.MESSAGE, - number=13, - message=source_context_pb2.ExtendedSourceContext, - ) - labels: MutableMapping[str, str] = 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 0c2fa0a..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py +++ /dev/null @@ -1,315 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_: data.Breakpoint = proto.Field( - proto.MESSAGE, - number=2, - message=data.Breakpoint, - ) - client_version: str = 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_: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_id: str = proto.Field( - proto.STRING, - number=2, - ) - client_version: str = 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_: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_id: str = proto.Field( - proto.STRING, - number=2, - ) - client_version: str = 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: data.Breakpoint.Action = proto.Field( - proto.ENUM, - number=1, - enum=data.Breakpoint.Action, - ) - - debuggee_id: str = proto.Field( - proto.STRING, - number=1, - ) - include_all_users: bool = proto.Field( - proto.BOOL, - number=2, - ) - include_inactive: bool = proto.Field( - proto.BOOL, - number=3, - ) - action: BreakpointActionValue = proto.Field( - proto.MESSAGE, - number=4, - message=BreakpointActionValue, - ) - strip_results: bool = proto.Field( - proto.BOOL, - number=5, - ) - wait_token: str = proto.Field( - proto.STRING, - number=6, - ) - client_version: str = proto.Field( - proto.STRING, - number=8, - ) - - -class ListBreakpointsResponse(proto.Message): - r"""Response for listing breakpoints. - - Attributes: - breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - next_wait_token: str = 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: str = proto.Field( - proto.STRING, - number=2, - ) - include_inactive: bool = proto.Field( - proto.BOOL, - number=3, - ) - client_version: str = proto.Field( - proto.STRING, - number=4, - ) - - -class ListDebuggeesResponse(proto.Message): - r"""Response for listing debuggees. - - Attributes: - debuggees (MutableSequence[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: MutableSequence[data.Debuggee] = 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 574c5ae..0000000 --- a/owl-bot-staging/v2/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/v2/noxfile.py b/owl-bot-staging/v2/noxfile.py deleted file mode 100644 index 02ef930..0000000 --- a/owl-bot-staging/v2/noxfile.py +++ /dev/null @@ -1,184 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", -] - -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") - -BLACK_VERSION = "black==22.3.0" -BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] -DEFAULT_PYTHON_VERSION = "3.11" - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", - "blacken", - "lint", - "lint_setup_py", -] - -@nox.session(python=ALL_PYTHON) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/debugger_v2/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -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=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - 'mypy', - 'types-requests', - 'types-protobuf' - ) - 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=DEFAULT_PYTHON_VERSION) -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", ""), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint(session): - """Run linters. - - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install("flake8", BLACK_VERSION) - session.run( - "black", - "--check", - *BLACK_PATHS, - ) - session.run("flake8", "google", "tests", "samples") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *BLACK_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py deleted file mode 100644 index 24f6ea0..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListActiveBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py deleted file mode 100644 index 67c27c7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListActiveBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py deleted file mode 100644 index b0ac801..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDebuggee -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = await client.register_debuggee(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py deleted file mode 100644 index 99f6287..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDebuggee -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = client.register_debuggee(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py deleted file mode 100644 index e74e3e7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateActiveBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py deleted file mode 100644 index 10a9948..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateActiveBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py deleted file mode 100644 index b445c89..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - await client.delete_breakpoint(request=request) - - -# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py deleted file mode 100644 index 01599f2..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - client.delete_breakpoint(request=request) - - -# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py deleted file mode 100644 index 7074dcf..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.get_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py deleted file mode 100644 index 3f7ebd0..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.get_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py deleted file mode 100644 index 816dd2b..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py deleted file mode 100644 index 4f65108..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py deleted file mode 100644 index fda422c..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListDebuggees -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_debuggees(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py deleted file mode 100644 index 246e83f..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListDebuggees -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_debuggees(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py deleted file mode 100644 index 6267555..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.set_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py deleted file mode 100644 index 22b41d7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.set_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json deleted file mode 100644 index ab6c88f..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json +++ /dev/null @@ -1,1369 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.devtools.clouddebugger.v2", - "version": "v2" - } - ], - "language": "PYTHON", - "name": "google-cloud-debugger-client", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.list_active_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "ListActiveBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", - "shortName": "list_active_breakpoints" - }, - "description": "Sample for ListActiveBreakpoints", - "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.list_active_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "ListActiveBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", - "shortName": "list_active_breakpoints" - }, - "description": "Sample for ListActiveBreakpoints", - "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.register_debuggee", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "RegisterDebuggee" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" - }, - { - "name": "debuggee", - "type": "google.cloud.debugger_v2.types.Debuggee" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", - "shortName": "register_debuggee" - }, - "description": "Sample for RegisterDebuggee", - "file": "clouddebugger_v2_generated_controller2_register_debuggee_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_async", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_register_debuggee_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.register_debuggee", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "RegisterDebuggee" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" - }, - { - "name": "debuggee", - "type": "google.cloud.debugger_v2.types.Debuggee" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", - "shortName": "register_debuggee" - }, - "description": "Sample for RegisterDebuggee", - "file": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.update_active_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "UpdateActiveBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", - "shortName": "update_active_breakpoint" - }, - "description": "Sample for UpdateActiveBreakpoint", - "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.update_active_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "UpdateActiveBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", - "shortName": "update_active_breakpoint" - }, - "description": "Sample for UpdateActiveBreakpoint", - "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.delete_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "DeleteBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_breakpoint" - }, - "description": "Sample for DeleteBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.delete_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "DeleteBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_breakpoint" - }, - "description": "Sample for DeleteBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.get_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "GetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", - "shortName": "get_breakpoint" - }, - "description": "Sample for GetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_async", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.get_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "GetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", - "shortName": "get_breakpoint" - }, - "description": "Sample for GetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", - "shortName": "list_breakpoints" - }, - "description": "Sample for ListBreakpoints", - "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.list_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", - "shortName": "list_breakpoints" - }, - "description": "Sample for ListBreakpoints", - "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_debuggees", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListDebuggees" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" - }, - { - "name": "project", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", - "shortName": "list_debuggees" - }, - "description": "Sample for ListDebuggees", - "file": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.list_debuggees", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListDebuggees" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" - }, - { - "name": "project", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", - "shortName": "list_debuggees" - }, - "description": "Sample for ListDebuggees", - "file": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.set_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "SetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", - "shortName": "set_breakpoint" - }, - "description": "Sample for SetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.set_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "SetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", - "shortName": "set_breakpoint" - }, - "description": "Sample for SetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py" - } - ] -} 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 9802c14..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 2022 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 4295418..0000000 --- a/owl-bot-staging/v2/setup.py +++ /dev/null @@ -1,90 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-cloud-debugger-client' - - -description = "Google Cloud Debugger Client API client library" - -version = {} -with open(os.path.join(package_root, 'google/cloud/debugger/gapic_version.py')) as fp: - exec(fp.read(), version) -version = version["__version__"] - -if version[0] == "0": - release_status = "Development Status :: 4 - Beta" -else: - release_status = "Development Status :: 5 - Production/Stable" - -dependencies = [ - "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - "proto-plus >= 1.22.0, <2.0.0dev", - "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", - "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", -] -url = "https://github.com/googleapis/python-debugger-client" - -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() - -packages = [ - package - for package in setuptools.PEP420PackageFinder.find() - if package.startswith("google") -] - -namespaces = ["google", "google.cloud"] - -setuptools.setup( - name=name, - version=version, - description=description, - long_description=readme, - author="Google LLC", - author_email="googleapis-packages@google.com", - license="Apache 2.0", - url=url, - classifiers=[ - release_status, - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - namespace_packages=namespaces, - install_requires=dependencies, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/v2/testing/constraints-3.10.txt b/owl-bot-staging/v2/testing/constraints-3.10.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.10.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.11.txt b/owl-bot-staging/v2/testing/constraints-3.11.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.11.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.12.txt b/owl-bot-staging/v2/testing/constraints-3.12.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.12.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.7.txt b/owl-bot-staging/v2/testing/constraints-3.7.txt deleted file mode 100644 index 6c44adf..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.7.txt +++ /dev/null @@ -1,9 +0,0 @@ -# This constraints file is used to check that lower bounds -# are correct in setup.py -# List all library dependencies and extras in this file. -# Pin the version to the lower bound. -# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.0 -proto-plus==1.22.0 -protobuf==3.19.5 diff --git a/owl-bot-staging/v2/testing/constraints-3.8.txt b/owl-bot-staging/v2/testing/constraints-3.8.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.8.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.9.txt b/owl-bot-staging/v2/testing/constraints-3.9.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.9.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v2/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 5058381..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py +++ /dev/null @@ -1,2551 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -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,transport_name", [ - (Controller2Client, "grpc"), - (Controller2AsyncClient, "grpc_asyncio"), - (Controller2Client, "rest"), -]) -def test_controller2_client_from_service_account_info(client_class, transport_name): - 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, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.Controller2GrpcTransport, "grpc"), - (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), - (transports.Controller2RestTransport, "rest"), -]) -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,transport_name", [ - (Controller2Client, "grpc"), - (Controller2AsyncClient, "grpc_asyncio"), - (Controller2Client, "rest"), -]) -def test_controller2_client_from_service_account_file(client_class, transport_name): - 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", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -def test_controller2_client_get_transport_class(): - transport = Controller2Client.get_transport_class() - available_transports = [ - transports.Controller2GrpcTransport, - transports.Controller2RestTransport, - ] - 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"), - (Controller2Client, transports.Controller2RestTransport, "rest"), -]) -@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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - 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=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@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"), - (Controller2Client, transports.Controller2RestTransport, "rest", "true"), - (Controller2Client, transports.Controller2RestTransport, "rest", "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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - -@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"), - (Controller2Client, transports.Controller2RestTransport, "rest"), -]) -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, - api_audience=None, - ) - -@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), - (Controller2Client, transports.Controller2RestTransport, "rest", None), -]) -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, - api_audience=None, - ) - -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, - api_audience=None, - ) - - -@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, - api_audience=None, - ) - - # 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_field_headers(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.ListActiveBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # 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: - call.return_value = controller.ListActiveBreakpointsResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_active_breakpoints_field_headers_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.ListActiveBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # 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: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.UpdateActiveBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint.id = 'id_value' - - # 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: - call.return_value = controller.UpdateActiveBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_active_breakpoint_field_headers_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.UpdateActiveBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint.id = 'id_value' - - # 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: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', - ) in kw['metadata'] - - -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'), - ) - - -@pytest.mark.parametrize("request_type", [ - controller.RegisterDebuggeeRequest, - dict, -]) -def test_register_debuggee_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.register_debuggee(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.RegisterDebuggeeResponse) - - -def test_register_debuggee_rest_required_fields(request_type=controller.RegisterDebuggeeRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.register_debuggee(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_register_debuggee_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.register_debuggee._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("debuggee", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_register_debuggee_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_register_debuggee") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_register_debuggee") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.RegisterDebuggeeRequest.pb(controller.RegisterDebuggeeRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.RegisterDebuggeeResponse.to_json(controller.RegisterDebuggeeResponse()) - - request = controller.RegisterDebuggeeRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.RegisterDebuggeeResponse() - - client.register_debuggee(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_register_debuggee_rest_bad_request(transport: str = 'rest', request_type=controller.RegisterDebuggeeRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.register_debuggee(request) - - -def test_register_debuggee_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {} - - # get truthy value for each flattened field - mock_args = dict( - debuggee=data.Debuggee(id='id_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.register_debuggee(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/register" % client.transport._host, args[1]) - - -def test_register_debuggee_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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'), - ) - - -def test_register_debuggee_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - controller.ListActiveBreakpointsRequest, - dict, -]) -def test_list_active_breakpoints_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse( - next_wait_token='next_wait_token_value', - wait_expired=True, - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_active_breakpoints(request) - - # 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_rest_required_fields(request_type=controller.ListActiveBreakpointsRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("success_on_timeout", "wait_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_active_breakpoints(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_active_breakpoints_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_active_breakpoints._get_unset_required_fields({}) - assert set(unset_fields) == (set(("successOnTimeout", "waitToken", )) & set(("debuggeeId", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_active_breakpoints_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_list_active_breakpoints") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_list_active_breakpoints") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.ListActiveBreakpointsRequest.pb(controller.ListActiveBreakpointsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.ListActiveBreakpointsResponse.to_json(controller.ListActiveBreakpointsResponse()) - - request = controller.ListActiveBreakpointsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.ListActiveBreakpointsResponse() - - client.list_active_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_active_breakpoints_rest_bad_request(transport: str = 'rest', request_type=controller.ListActiveBreakpointsRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_active_breakpoints(request) - - -def test_list_active_breakpoints_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_active_breakpoints(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) - - -def test_list_active_breakpoints_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_active_breakpoints_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - controller.UpdateActiveBreakpointRequest, - dict, -]) -def test_update_active_breakpoint_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.update_active_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.UpdateActiveBreakpointResponse) - - -def test_update_active_breakpoint_rest_required_fields(request_type=controller.UpdateActiveBreakpointRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "put", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.update_active_breakpoint(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_update_active_breakpoint_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.update_active_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("debuggeeId", "breakpoint", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_active_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_update_active_breakpoint") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_update_active_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.UpdateActiveBreakpointRequest.pb(controller.UpdateActiveBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.UpdateActiveBreakpointResponse.to_json(controller.UpdateActiveBreakpointResponse()) - - request = controller.UpdateActiveBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.UpdateActiveBreakpointResponse() - - client.update_active_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_update_active_breakpoint_rest_bad_request(transport: str = 'rest', request_type=controller.UpdateActiveBreakpointRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.update_active_breakpoint(request) - - -def test_update_active_breakpoint_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.update_active_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}" % client.transport._host, args[1]) - - -def test_update_active_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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'), - ) - - -def test_update_active_breakpoint_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -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, - transports.Controller2RestTransport, -]) -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() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = Controller2Client.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -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() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -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", - [ - transports.Controller2GrpcTransport, - transports.Controller2GrpcAsyncIOTransport, - transports.Controller2RestTransport, - ], -) -def test_controller2_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@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_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.Controller2RestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_controller2_host_no_port(transport_name): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_controller2_host_with_port(transport_name): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_controller2_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = Controller2Client( - credentials=creds1, - transport=transport_name, - ) - client2 = Controller2Client( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.register_debuggee._session - session2 = client2.transport.register_debuggee._session - assert session1 != session2 - session1 = client1.transport.list_active_breakpoints._session - session2 = client2.transport.list_active_breakpoints._session - assert session1 != session2 - session1 = client1.transport.update_active_breakpoint._session - session2 = client2.transport.update_active_breakpoint._session - assert session1 != session2 -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 = { - "rest": "_session", - "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 = [ - 'rest', - '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, - api_audience=None, - ) 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 ad07b63..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py +++ /dev/null @@ -1,3628 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -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,transport_name", [ - (Debugger2Client, "grpc"), - (Debugger2AsyncClient, "grpc_asyncio"), - (Debugger2Client, "rest"), -]) -def test_debugger2_client_from_service_account_info(client_class, transport_name): - 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, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.Debugger2GrpcTransport, "grpc"), - (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), - (transports.Debugger2RestTransport, "rest"), -]) -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,transport_name", [ - (Debugger2Client, "grpc"), - (Debugger2AsyncClient, "grpc_asyncio"), - (Debugger2Client, "rest"), -]) -def test_debugger2_client_from_service_account_file(client_class, transport_name): - 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", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -def test_debugger2_client_get_transport_class(): - transport = Debugger2Client.get_transport_class() - available_transports = [ - transports.Debugger2GrpcTransport, - transports.Debugger2RestTransport, - ] - 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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest"), -]) -@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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - 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=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest", "true"), - (Debugger2Client, transports.Debugger2RestTransport, "rest", "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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - -@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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest"), -]) -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, - api_audience=None, - ) - -@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), - (Debugger2Client, transports.Debugger2RestTransport, "rest", None), -]) -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, - api_audience=None, - ) - -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, - api_audience=None, - ) - - -@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, - api_audience=None, - ) - - # 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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.SetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - call.return_value = debugger.SetBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_set_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.SetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.GetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - call.return_value = debugger.GetBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.GetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.DeleteBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - call.return_value = None - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.DeleteBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.ListBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - call.return_value = debugger.ListBreakpointsResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_breakpoints_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.ListBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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', - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.SetBreakpointRequest, - dict, -]) -def test_set_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.set_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.SetBreakpointResponse) - - -def test_set_breakpoint_rest_required_fields(request_type=debugger.SetBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("breakpoint_", "client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.set_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_set_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.set_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("breakpoint", "clientVersion", )) & set(("debuggeeId", "breakpoint", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_set_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_set_breakpoint") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_set_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.SetBreakpointRequest.pb(debugger.SetBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.SetBreakpointResponse.to_json(debugger.SetBreakpointResponse()) - - request = debugger.SetBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.SetBreakpointResponse() - - client.set_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_set_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.SetBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.set_breakpoint(request) - - -def test_set_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.set_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/set" % client.transport._host, args[1]) - - -def test_set_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_set_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.GetBreakpointRequest, - dict, -]) -def test_get_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.get_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.GetBreakpointResponse) - - -def test_get_breakpoint_rest_required_fields(request_type=debugger.GetBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["breakpoint_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["breakpointId"] = 'breakpoint_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "breakpointId" in jsonified_request - assert jsonified_request["breakpointId"] == 'breakpoint_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.get_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_get_breakpoint") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_get_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.GetBreakpointRequest.pb(debugger.GetBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.GetBreakpointResponse.to_json(debugger.GetBreakpointResponse()) - - request = debugger.GetBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.GetBreakpointResponse() - - client.get_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.GetBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.get_breakpoint(request) - - -def test_get_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.get_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) - - -def test_get_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_get_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.DeleteBreakpointRequest, - dict, -]) -def test_delete_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.delete_breakpoint(request) - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_breakpoint_rest_required_fields(request_type=debugger.DeleteBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["breakpoint_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["breakpointId"] = 'breakpoint_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "breakpointId" in jsonified_request - assert jsonified_request["breakpointId"] == 'breakpoint_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = None - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "delete", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.delete_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_delete_breakpoint") as pre: - pre.assert_not_called() - pb_message = debugger.DeleteBreakpointRequest.pb(debugger.DeleteBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - - request = debugger.DeleteBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.delete_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_delete_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.DeleteBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.delete_breakpoint(request) - - -def test_delete_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.delete_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) - - -def test_delete_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_delete_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.ListBreakpointsRequest, - dict, -]) -def test_list_breakpoints_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse( - next_wait_token='next_wait_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_breakpoints(request) - - # 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_rest_required_fields(request_type=debugger.ListBreakpointsRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("action", "client_version", "include_all_users", "include_inactive", "strip_results", "wait_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_breakpoints(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_breakpoints_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_breakpoints._get_unset_required_fields({}) - assert set(unset_fields) == (set(("action", "clientVersion", "includeAllUsers", "includeInactive", "stripResults", "waitToken", )) & set(("debuggeeId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_breakpoints_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_list_breakpoints") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_breakpoints") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.ListBreakpointsRequest.pb(debugger.ListBreakpointsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.ListBreakpointsResponse.to_json(debugger.ListBreakpointsResponse()) - - request = debugger.ListBreakpointsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.ListBreakpointsResponse() - - client.list_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_breakpoints_rest_bad_request(transport: str = 'rest', request_type=debugger.ListBreakpointsRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_breakpoints(request) - - -def test_list_breakpoints_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_breakpoints(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) - - -def test_list_breakpoints_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_breakpoints_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.ListDebuggeesRequest, - dict, -]) -def test_list_debuggees_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_debuggees(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.ListDebuggeesResponse) - - -def test_list_debuggees_rest_required_fields(request_type=debugger.ListDebuggeesRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["project"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "project" not in jsonified_request - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "project" in jsonified_request - assert jsonified_request["project"] == request_init["project"] - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["project"] = 'project_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", "include_inactive", "project", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "project" in jsonified_request - assert jsonified_request["project"] == 'project_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_debuggees(request) - - expected_params = [ - ( - "project", - "", - ), - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_debuggees_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_debuggees._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", "includeInactive", "project", )) & set(("project", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_debuggees_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_list_debuggees") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_debuggees") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.ListDebuggeesRequest.pb(debugger.ListDebuggeesRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.ListDebuggeesResponse.to_json(debugger.ListDebuggeesResponse()) - - request = debugger.ListDebuggeesRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.ListDebuggeesResponse() - - client.list_debuggees(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_debuggees_rest_bad_request(transport: str = 'rest', request_type=debugger.ListDebuggeesRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_debuggees(request) - - -def test_list_debuggees_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {} - - # get truthy value for each flattened field - mock_args = dict( - project='project_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_debuggees(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees" % client.transport._host, args[1]) - - -def test_list_debuggees_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_debuggees_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -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, - transports.Debugger2RestTransport, -]) -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() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = Debugger2Client.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -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() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -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", - [ - transports.Debugger2GrpcTransport, - transports.Debugger2GrpcAsyncIOTransport, - transports.Debugger2RestTransport, - ], -) -def test_debugger2_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@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_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.Debugger2RestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_debugger2_host_no_port(transport_name): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_debugger2_host_with_port(transport_name): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_debugger2_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = Debugger2Client( - credentials=creds1, - transport=transport_name, - ) - client2 = Debugger2Client( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.set_breakpoint._session - session2 = client2.transport.set_breakpoint._session - assert session1 != session2 - session1 = client1.transport.get_breakpoint._session - session2 = client2.transport.get_breakpoint._session - assert session1 != session2 - session1 = client1.transport.delete_breakpoint._session - session2 = client2.transport.delete_breakpoint._session - assert session1 != session2 - session1 = client1.transport.list_breakpoints._session - session2 = client2.transport.list_breakpoints._session - assert session1 != session2 - session1 = client1.transport.list_debuggees._session - session2 = client2.transport.list_debuggees._session - assert session1 != session2 -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 = { - "rest": "_session", - "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 = [ - 'rest', - '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, - api_audience=None, - ) From f36b0dd1cec63c8a8b46984c36a79c22752fd866 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 22 Mar 2023 20:28:50 +0000 Subject: [PATCH 05/10] docs: Fix formatting of request arg in docstring chore: Update gapic-generator-python to v1.9.1 PiperOrigin-RevId: 518604533 Source-Link: https://github.com/googleapis/googleapis/commit/8a085aeddfa010af5bcef090827aac5255383d7e Source-Link: https://github.com/googleapis/googleapis-gen/commit/b2ab4b0a0ae2907e812c209198a74e0898afcb04 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjJhYjRiMGEwYWUyOTA3ZTgxMmMyMDkxOThhNzRlMDg5OGFmY2IwNCJ9 --- owl-bot-staging/v2/.coveragerc | 13 + owl-bot-staging/v2/.flake8 | 33 + 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 | 6 + owl-bot-staging/v2/docs/index.rst | 7 + .../v2/google/cloud/debugger/__init__.py | 75 + .../v2/google/cloud/debugger/gapic_version.py | 16 + .../v2/google/cloud/debugger/py.typed | 2 + .../v2/google/cloud/debugger_v2/__init__.py | 76 + .../cloud/debugger_v2/gapic_metadata.json | 167 + .../google/cloud/debugger_v2/gapic_version.py | 16 + .../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 | 566 +++ .../services/controller2/client.py | 747 ++++ .../controller2/transports/__init__.py | 38 + .../services/controller2/transports/base.py | 191 + .../services/controller2/transports/grpc.py | 369 ++ .../controller2/transports/grpc_asyncio.py | 368 ++ .../services/controller2/transports/rest.py | 553 +++ .../services/debugger2/__init__.py | 22 + .../services/debugger2/async_client.py | 806 ++++ .../debugger_v2/services/debugger2/client.py | 973 +++++ .../services/debugger2/transports/__init__.py | 38 + .../services/debugger2/transports/base.py | 234 ++ .../services/debugger2/transports/grpc.py | 381 ++ .../debugger2/transports/grpc_asyncio.py | 380 ++ .../services/debugger2/transports/rest.py | 729 ++++ .../cloud/debugger_v2/types/__init__.py | 68 + .../cloud/debugger_v2/types/controller.py | 176 + .../v2/google/cloud/debugger_v2/types/data.py | 681 ++++ .../cloud/debugger_v2/types/debugger.py | 315 ++ owl-bot-staging/v2/mypy.ini | 3 + owl-bot-staging/v2/noxfile.py | 184 + ...ntroller2_list_active_breakpoints_async.py | 52 + ...ontroller2_list_active_breakpoints_sync.py | 52 + ...ted_controller2_register_debuggee_async.py | 51 + ...ated_controller2_register_debuggee_sync.py | 51 + ...troller2_update_active_breakpoint_async.py | 52 + ...ntroller2_update_active_breakpoint_sync.py | 52 + ...rated_debugger2_delete_breakpoint_async.py | 52 + ...erated_debugger2_delete_breakpoint_sync.py | 52 + ...enerated_debugger2_get_breakpoint_async.py | 54 + ...generated_debugger2_get_breakpoint_sync.py | 54 + ...erated_debugger2_list_breakpoints_async.py | 53 + ...nerated_debugger2_list_breakpoints_sync.py | 53 + ...enerated_debugger2_list_debuggees_async.py | 53 + ...generated_debugger2_list_debuggees_sync.py | 53 + ...enerated_debugger2_set_breakpoint_async.py | 53 + ...generated_debugger2_set_breakpoint_sync.py | 53 + ...data_google.devtools.clouddebugger.v2.json | 1369 +++++++ .../v2/scripts/fixup_debugger_v2_keywords.py | 183 + owl-bot-staging/v2/setup.py | 90 + .../v2/testing/constraints-3.10.txt | 6 + .../v2/testing/constraints-3.11.txt | 6 + .../v2/testing/constraints-3.12.txt | 6 + .../v2/testing/constraints-3.7.txt | 9 + .../v2/testing/constraints-3.8.txt | 6 + .../v2/testing/constraints-3.9.txt | 6 + 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 | 2551 ++++++++++++ .../unit/gapic/debugger_v2/test_debugger2.py | 3628 +++++++++++++++++ 71 files changed, 17482 insertions(+) create mode 100644 owl-bot-staging/v2/.coveragerc create mode 100644 owl-bot-staging/v2/.flake8 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/gapic_version.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/gapic_version.py 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/controller2/transports/rest.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/services/debugger2/transports/rest.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/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json 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/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.9.txt 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..9620812 --- /dev/null +++ b/owl-bot-staging/v2/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/debugger/__init__.py + google/cloud/debugger/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v2/.flake8 b/owl-bot-staging/v2/.flake8 new file mode 100644 index 0000000..29227d4 --- /dev/null +++ b/owl-bot-staging/v2/.flake8 @@ -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 +# +# https://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. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py 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..4ad5ea1 --- /dev/null +++ b/owl-bot-staging/v2/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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"2022, 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..0106467 --- /dev/null +++ b/owl-bot-staging/v2/docs/debugger_v2/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Debugger v2 API +====================================== + +.. automodule:: google.cloud.debugger_v2.types + :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..1228468 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger/__init__.py @@ -0,0 +1,75 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 import gapic_version as package_version + +__version__ = package_version.__version__ + + +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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +__version__ = "0.1.0" # {x-release-please-version} 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..c774017 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 import gapic_version as package_version + +__version__ = package_version.__version__ + + +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..f0d8a90 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json @@ -0,0 +1,167 @@ + { + "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" + ] + } + } + }, + "rest": { + "libraryClient": "Controller2Client", + "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" + ] + } + } + }, + "rest": { + "libraryClient": "Debugger2Client", + "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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py new file mode 100644 index 0000000..405b1ce --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +__version__ = "0.1.0" # {x-release-please-version} 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..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..e010a73 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..aa29878 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py @@ -0,0 +1,566 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 variable 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: Optional[ga_credentials.Credentials] = None, + transport: Union[str, Controller2Transport] = "grpc_asyncio", + client_options: Optional[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: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, + *, + debuggee: Optional[data.Debuggee] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = await client.register_debuggee(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint.id", request.breakpoint.id), + )), + ) + + # 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() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..7330718 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py @@ -0,0 +1,747 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 +from .transports.rest import Controller2RestTransport + + +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 + _transport_registry["rest"] = Controller2RestTransport + + def get_transport_class(cls, + label: Optional[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 variable 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: Optional[Union[str, Controller2Transport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() + client_options = cast(client_options_lib.ClientOptions, client_options) + + 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, + api_audience=client_options.api_audience, + ) + + def register_debuggee(self, + request: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, + *, + debuggee: Optional[data.Debuggee] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = client.register_debuggee(request=request) + + # Handle the response + print(response) + + 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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_active_breakpoint(self, + request: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint.id", request.breakpoint.id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "Controller2Client": + 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() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..0381ff4 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +from .rest import Controller2RestTransport +from .rest import Controller2RestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] +_transport_registry['grpc'] = Controller2GrpcTransport +_transport_registry['grpc_asyncio'] = Controller2GrpcAsyncIOTransport +_transport_registry['rest'] = Controller2RestTransport + +__all__ = ( + 'Controller2Transport', + 'Controller2GrpcTransport', + 'Controller2GrpcAsyncIOTransport', + 'Controller2RestTransport', + 'Controller2RestInterceptor', +) 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..8e480a6 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py @@ -0,0 +1,191 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +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: Optional[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, + api_audience: Optional[str] = None, + **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. + """ + + 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) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # 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 + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + 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() + + @property + def kind(self) -> str: + 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..09e2efa --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py @@ -0,0 +1,369 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[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() + + @property + def kind(self) -> str: + return "grpc" + + +__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..ae65db1 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py @@ -0,0 +1,368 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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/controller2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py new file mode 100644 index 0000000..e172241 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py @@ -0,0 +1,553 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +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 .base import Controller2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class Controller2RestInterceptor: + """Interceptor for Controller2. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the Controller2RestTransport. + + .. code-block:: python + class MyCustomController2Interceptor(Controller2RestInterceptor): + def pre_list_active_breakpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_active_breakpoints(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_register_debuggee(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_register_debuggee(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_active_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_active_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + transport = Controller2RestTransport(interceptor=MyCustomController2Interceptor()) + client = Controller2Client(transport=transport) + + + """ + def pre_list_active_breakpoints(self, request: controller.ListActiveBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.ListActiveBreakpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_active_breakpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_list_active_breakpoints(self, response: controller.ListActiveBreakpointsResponse) -> controller.ListActiveBreakpointsResponse: + """Post-rpc interceptor for list_active_breakpoints + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + def pre_register_debuggee(self, request: controller.RegisterDebuggeeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.RegisterDebuggeeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for register_debuggee + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_register_debuggee(self, response: controller.RegisterDebuggeeResponse) -> controller.RegisterDebuggeeResponse: + """Post-rpc interceptor for register_debuggee + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + def pre_update_active_breakpoint(self, request: controller.UpdateActiveBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.UpdateActiveBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_active_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_update_active_breakpoint(self, response: controller.UpdateActiveBreakpointResponse) -> controller.UpdateActiveBreakpointResponse: + """Post-rpc interceptor for update_active_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class Controller2RestStub: + _session: AuthorizedSession + _host: str + _interceptor: Controller2RestInterceptor + + +class Controller2RestTransport(Controller2Transport): + """REST 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 JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[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, + url_scheme: str = 'https', + interceptor: Optional[Controller2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> 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 ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` 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 are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or Controller2RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _ListActiveBreakpoints(Controller2RestStub): + def __hash__(self): + return hash("ListActiveBreakpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.ListActiveBreakpointsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.ListActiveBreakpointsResponse: + r"""Call the list active breakpoints method over HTTP. + + Args: + request (~.controller.ListActiveBreakpointsRequest): + The request object. Request to list active breakpoints. + 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: + ~.controller.ListActiveBreakpointsResponse: + Response for listing active + breakpoints. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints', + }, + ] + request, metadata = self._interceptor.pre_list_active_breakpoints(request, metadata) + pb_request = controller.ListActiveBreakpointsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.ListActiveBreakpointsResponse() + pb_resp = controller.ListActiveBreakpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_active_breakpoints(resp) + return resp + + class _RegisterDebuggee(Controller2RestStub): + def __hash__(self): + return hash("RegisterDebuggee") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.RegisterDebuggeeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.RegisterDebuggeeResponse: + r"""Call the register debuggee method over HTTP. + + Args: + request (~.controller.RegisterDebuggeeRequest): + The request object. Request to register a debuggee. + 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: + ~.controller.RegisterDebuggeeResponse: + Response for registering a debuggee. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/controller/debuggees/register', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_register_debuggee(request, metadata) + pb_request = controller.RegisterDebuggeeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.RegisterDebuggeeResponse() + pb_resp = controller.RegisterDebuggeeResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_register_debuggee(resp) + return resp + + class _UpdateActiveBreakpoint(Controller2RestStub): + def __hash__(self): + return hash("UpdateActiveBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.UpdateActiveBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.UpdateActiveBreakpointResponse: + r"""Call the update active breakpoint method over HTTP. + + Args: + request (~.controller.UpdateActiveBreakpointRequest): + The request object. Request to update an active + breakpoint. + 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: + ~.controller.UpdateActiveBreakpointResponse: + Response for updating an active + breakpoint. The message is defined to + allow future extensions. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'put', + 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_update_active_breakpoint(request, metadata) + pb_request = controller.UpdateActiveBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.UpdateActiveBreakpointResponse() + pb_resp = controller.UpdateActiveBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_active_breakpoint(resp) + return resp + + @property + def list_active_breakpoints(self) -> Callable[ + [controller.ListActiveBreakpointsRequest], + controller.ListActiveBreakpointsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListActiveBreakpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def register_debuggee(self) -> Callable[ + [controller.RegisterDebuggeeRequest], + controller.RegisterDebuggeeResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RegisterDebuggee(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_active_breakpoint(self) -> Callable[ + [controller.UpdateActiveBreakpointRequest], + controller.UpdateActiveBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateActiveBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'Controller2RestTransport', +) 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..5d7f609 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..257c378 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py @@ -0,0 +1,806 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 variable 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: Optional[ga_credentials.Credentials] = None, + transport: Union[str, Debugger2Transport] = "grpc_asyncio", + client_options: Optional[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: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Sets the breakpoint to the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.set_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Gets breakpoint information. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.get_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # 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: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the breakpoint from the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + await client.delete_breakpoint(request=request) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def list_breakpoints(self, + request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Lists all breakpoints for the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_breakpoints(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, + *, + project: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Lists all the debuggees that the user has access to. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_debuggees(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..7e52f8d --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py @@ -0,0 +1,973 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 +from .transports.rest import Debugger2RestTransport + + +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 + _transport_registry["rest"] = Debugger2RestTransport + + def get_transport_class(cls, + label: Optional[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 variable 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: Optional[Union[str, Debugger2Transport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() + client_options = cast(client_options_lib.ClientOptions, client_options) + + 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, + api_audience=client_options.api_audience, + ) + + def set_breakpoint(self, + request: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Sets the breakpoint to the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.set_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_breakpoint(self, + request: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Gets breakpoint information. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.get_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_breakpoint(self, + request: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the breakpoint from the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + client.delete_breakpoint(request=request) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def list_breakpoints(self, + request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Lists all breakpoints for the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_breakpoints(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_debuggees(self, + request: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, + *, + project: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Lists all the debuggees that the user has access to. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_debuggees(request=request) + + # Handle the response + print(response) + + 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) -> "Debugger2Client": + 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() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..cd9dd46 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +from .rest import Debugger2RestTransport +from .rest import Debugger2RestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] +_transport_registry['grpc'] = Debugger2GrpcTransport +_transport_registry['grpc_asyncio'] = Debugger2GrpcAsyncIOTransport +_transport_registry['rest'] = Debugger2RestTransport + +__all__ = ( + 'Debugger2Transport', + 'Debugger2GrpcTransport', + 'Debugger2GrpcAsyncIOTransport', + 'Debugger2RestTransport', + 'Debugger2RestInterceptor', +) 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..c4afc0c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py @@ -0,0 +1,234 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +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: Optional[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, + api_audience: Optional[str] = None, + **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. + """ + + 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) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # 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 + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + 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() + + @property + def kind(self) -> str: + 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..fbb3374 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py @@ -0,0 +1,381 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[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() + + @property + def kind(self) -> str: + return "grpc" + + +__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..eb6eadc --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py @@ -0,0 +1,380 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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/services/debugger2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py new file mode 100644 index 0000000..63388ac --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py @@ -0,0 +1,729 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +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 debugger +from google.protobuf import empty_pb2 # type: ignore + +from .base import Debugger2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class Debugger2RestInterceptor: + """Interceptor for Debugger2. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the Debugger2RestTransport. + + .. code-block:: python + class MyCustomDebugger2Interceptor(Debugger2RestInterceptor): + def pre_delete_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_breakpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_breakpoints(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_debuggees(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_debuggees(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_set_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_set_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + transport = Debugger2RestTransport(interceptor=MyCustomDebugger2Interceptor()) + client = Debugger2Client(transport=transport) + + + """ + def pre_delete_breakpoint(self, request: debugger.DeleteBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.DeleteBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def pre_get_breakpoint(self, request: debugger.GetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.GetBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_get_breakpoint(self, response: debugger.GetBreakpointResponse) -> debugger.GetBreakpointResponse: + """Post-rpc interceptor for get_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_list_breakpoints(self, request: debugger.ListBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListBreakpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_breakpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_list_breakpoints(self, response: debugger.ListBreakpointsResponse) -> debugger.ListBreakpointsResponse: + """Post-rpc interceptor for list_breakpoints + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_list_debuggees(self, request: debugger.ListDebuggeesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListDebuggeesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_debuggees + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_list_debuggees(self, response: debugger.ListDebuggeesResponse) -> debugger.ListDebuggeesResponse: + """Post-rpc interceptor for list_debuggees + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_set_breakpoint(self, request: debugger.SetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.SetBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for set_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_set_breakpoint(self, response: debugger.SetBreakpointResponse) -> debugger.SetBreakpointResponse: + """Post-rpc interceptor for set_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class Debugger2RestStub: + _session: AuthorizedSession + _host: str + _interceptor: Debugger2RestInterceptor + + +class Debugger2RestTransport(Debugger2Transport): + """REST 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 JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[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, + url_scheme: str = 'https', + interceptor: Optional[Debugger2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> 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 ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` 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 are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or Debugger2RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _DeleteBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("DeleteBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.DeleteBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the delete breakpoint method over HTTP. + + Args: + request (~.debugger.DeleteBreakpointRequest): + The request object. Request to delete a breakpoint. + 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. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', + }, + ] + request, metadata = self._interceptor.pre_delete_breakpoint(request, metadata) + pb_request = debugger.DeleteBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("GetBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.GetBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.GetBreakpointResponse: + r"""Call the get breakpoint method over HTTP. + + Args: + request (~.debugger.GetBreakpointRequest): + The request object. Request to get breakpoint + information. + 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: + ~.debugger.GetBreakpointResponse: + Response for getting breakpoint + information. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', + }, + ] + request, metadata = self._interceptor.pre_get_breakpoint(request, metadata) + pb_request = debugger.GetBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.GetBreakpointResponse() + pb_resp = debugger.GetBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_breakpoint(resp) + return resp + + class _ListBreakpoints(Debugger2RestStub): + def __hash__(self): + return hash("ListBreakpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.ListBreakpointsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.ListBreakpointsResponse: + r"""Call the list breakpoints method over HTTP. + + Args: + request (~.debugger.ListBreakpointsRequest): + The request object. Request to list breakpoints. + 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: + ~.debugger.ListBreakpointsResponse: + Response for listing breakpoints. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints', + }, + ] + request, metadata = self._interceptor.pre_list_breakpoints(request, metadata) + pb_request = debugger.ListBreakpointsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.ListBreakpointsResponse() + pb_resp = debugger.ListBreakpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_breakpoints(resp) + return resp + + class _ListDebuggees(Debugger2RestStub): + def __hash__(self): + return hash("ListDebuggees") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "project" : "", "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.ListDebuggeesRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.ListDebuggeesResponse: + r"""Call the list debuggees method over HTTP. + + Args: + request (~.debugger.ListDebuggeesRequest): + The request object. Request to list debuggees. + 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: + ~.debugger.ListDebuggeesResponse: + Response for listing debuggees. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees', + }, + ] + request, metadata = self._interceptor.pre_list_debuggees(request, metadata) + pb_request = debugger.ListDebuggeesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.ListDebuggeesResponse() + pb_resp = debugger.ListDebuggeesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_debuggees(resp) + return resp + + class _SetBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("SetBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "breakpoint" : {}, "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.SetBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.SetBreakpointResponse: + r"""Call the set breakpoint method over HTTP. + + Args: + request (~.debugger.SetBreakpointRequest): + The request object. Request to set a breakpoint + 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: + ~.debugger.SetBreakpointResponse: + Response for setting a breakpoint. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/set', + 'body': 'breakpoint', + }, + ] + request, metadata = self._interceptor.pre_set_breakpoint(request, metadata) + pb_request = debugger.SetBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.SetBreakpointResponse() + pb_resp = debugger.SetBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_set_breakpoint(resp) + return resp + + @property + def delete_breakpoint(self) -> Callable[ + [debugger.DeleteBreakpointRequest], + empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_breakpoint(self) -> Callable[ + [debugger.GetBreakpointRequest], + debugger.GetBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_breakpoints(self) -> Callable[ + [debugger.ListBreakpointsRequest], + debugger.ListBreakpointsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListBreakpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_debuggees(self) -> Callable[ + [debugger.ListDebuggeesRequest], + debugger.ListDebuggeesResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListDebuggees(self._session, self._host, self._interceptor) # type: ignore + + @property + def set_breakpoint(self) -> Callable[ + [debugger.SetBreakpointRequest], + debugger.SetBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._SetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'Debugger2RestTransport', +) 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..9791b6c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py @@ -0,0 +1,68 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..2ed0286 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py @@ -0,0 +1,176 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +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: data.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: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + wait_token: str = proto.Field( + proto.STRING, + number=2, + ) + success_on_timeout: bool = proto.Field( + proto.BOOL, + number=3, + ) + + +class ListActiveBreakpointsResponse(proto.Message): + r"""Response for listing active breakpoints. + + Attributes: + breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + next_wait_token: str = proto.Field( + proto.STRING, + number=2, + ) + wait_expired: bool = 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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_: data.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..42e4206 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py @@ -0,0 +1,681 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +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 (MutableSequence[str]): + Optional parameters to be embedded into the + message. + """ + + format_: str = proto.Field( + proto.STRING, + number=1, + ) + parameters: MutableSequence[str] = 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. + + Values: + UNSPECIFIED (0): + Status doesn't refer to any particular input. + BREAKPOINT_SOURCE_LOCATION (3): + Status applies to the breakpoint and is + related to its location. + BREAKPOINT_CONDITION (4): + Status applies to the breakpoint and is + related to its condition. + BREAKPOINT_EXPRESSION (7): + Status applies to the breakpoint and is + related to its expressions. + BREAKPOINT_AGE (8): + Status applies to the breakpoint and is + related to its age. + VARIABLE_NAME (5): + Status applies to the entire variable. + VARIABLE_VALUE (6): + Status applies to variable value (variable + name is valid). + """ + UNSPECIFIED = 0 + BREAKPOINT_SOURCE_LOCATION = 3 + BREAKPOINT_CONDITION = 4 + BREAKPOINT_EXPRESSION = 7 + BREAKPOINT_AGE = 8 + VARIABLE_NAME = 5 + VARIABLE_VALUE = 6 + + is_error: bool = proto.Field( + proto.BOOL, + number=1, + ) + refers_to: Reference = proto.Field( + proto.ENUM, + number=2, + enum=Reference, + ) + description: 'FormatMessage' = 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: str = proto.Field( + proto.STRING, + number=1, + ) + line: int = proto.Field( + proto.INT32, + number=2, + ) + column: int = 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 (MutableSequence[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: str = proto.Field( + proto.STRING, + number=1, + ) + value: str = proto.Field( + proto.STRING, + number=2, + ) + type_: str = proto.Field( + proto.STRING, + number=6, + ) + members: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='Variable', + ) + var_table_index: wrappers_pb2.Int32Value = proto.Field( + proto.MESSAGE, + number=4, + message=wrappers_pb2.Int32Value, + ) + status: 'StatusMessage' = 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 (MutableSequence[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_ (MutableSequence[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: str = proto.Field( + proto.STRING, + number=1, + ) + location: 'SourceLocation' = proto.Field( + proto.MESSAGE, + number=2, + message='SourceLocation', + ) + arguments: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='Variable', + ) + locals_: MutableSequence['Variable'] = 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 (MutableSequence[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 (MutableSequence[google.cloud.debugger_v2.types.StackFrame]): + The stack at breakpoint time, where stack_frames[0] + represents the most recently entered function. + evaluated_expressions (MutableSequence[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 (MutableSequence[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 (MutableMapping[str, str]): + 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. + + Values: + CAPTURE (0): + Capture stack frame and variables and update + the breakpoint. The data is only captured once. + After that the breakpoint is set in a final + state. + LOG (1): + Log each breakpoint hit. The breakpoint + remains active until deleted or expired. + """ + CAPTURE = 0 + LOG = 1 + + class LogLevel(proto.Enum): + r"""Log severity levels. + + Values: + INFO (0): + Information log message. + WARNING (1): + Warning log message. + ERROR (2): + Error log message. + """ + INFO = 0 + WARNING = 1 + ERROR = 2 + + id: str = proto.Field( + proto.STRING, + number=1, + ) + action: Action = proto.Field( + proto.ENUM, + number=13, + enum=Action, + ) + location: 'SourceLocation' = proto.Field( + proto.MESSAGE, + number=2, + message='SourceLocation', + ) + condition: str = proto.Field( + proto.STRING, + number=3, + ) + expressions: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=4, + ) + log_message_format: str = proto.Field( + proto.STRING, + number=14, + ) + log_level: LogLevel = proto.Field( + proto.ENUM, + number=15, + enum=LogLevel, + ) + is_final_state: bool = proto.Field( + proto.BOOL, + number=5, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=11, + message=timestamp_pb2.Timestamp, + ) + final_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=12, + message=timestamp_pb2.Timestamp, + ) + user_email: str = proto.Field( + proto.STRING, + number=16, + ) + status: 'StatusMessage' = proto.Field( + proto.MESSAGE, + number=10, + message='StatusMessage', + ) + stack_frames: MutableSequence['StackFrame'] = proto.RepeatedField( + proto.MESSAGE, + number=7, + message='StackFrame', + ) + evaluated_expressions: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=8, + message='Variable', + ) + variable_table: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=9, + message='Variable', + ) + labels: MutableMapping[str, str] = 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 (MutableSequence[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 (MutableSequence[google.devtools.source.v1.source_context_pb2.ExtendedSourceContext]): + References to the locations and revisions of + the source code used in the deployed + application. + labels (MutableMapping[str, str]): + A set of custom debuggee properties, + populated by the agent, to be displayed to the + user. + """ + + id: str = proto.Field( + proto.STRING, + number=1, + ) + project: str = proto.Field( + proto.STRING, + number=2, + ) + uniquifier: str = proto.Field( + proto.STRING, + number=3, + ) + description: str = proto.Field( + proto.STRING, + number=4, + ) + is_inactive: bool = proto.Field( + proto.BOOL, + number=5, + ) + agent_version: str = proto.Field( + proto.STRING, + number=6, + ) + is_disabled: bool = proto.Field( + proto.BOOL, + number=7, + ) + status: 'StatusMessage' = proto.Field( + proto.MESSAGE, + number=8, + message='StatusMessage', + ) + source_contexts: MutableSequence[source_context_pb2.SourceContext] = proto.RepeatedField( + proto.MESSAGE, + number=9, + message=source_context_pb2.SourceContext, + ) + ext_source_contexts: MutableSequence[source_context_pb2.ExtendedSourceContext] = proto.RepeatedField( + proto.MESSAGE, + number=13, + message=source_context_pb2.ExtendedSourceContext, + ) + labels: MutableMapping[str, str] = 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..0c2fa0a --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py @@ -0,0 +1,315 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_: data.Breakpoint = proto.Field( + proto.MESSAGE, + number=2, + message=data.Breakpoint, + ) + client_version: str = 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_: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_id: str = proto.Field( + proto.STRING, + number=2, + ) + client_version: str = 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_: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_id: str = proto.Field( + proto.STRING, + number=2, + ) + client_version: str = 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: data.Breakpoint.Action = proto.Field( + proto.ENUM, + number=1, + enum=data.Breakpoint.Action, + ) + + debuggee_id: str = proto.Field( + proto.STRING, + number=1, + ) + include_all_users: bool = proto.Field( + proto.BOOL, + number=2, + ) + include_inactive: bool = proto.Field( + proto.BOOL, + number=3, + ) + action: BreakpointActionValue = proto.Field( + proto.MESSAGE, + number=4, + message=BreakpointActionValue, + ) + strip_results: bool = proto.Field( + proto.BOOL, + number=5, + ) + wait_token: str = proto.Field( + proto.STRING, + number=6, + ) + client_version: str = proto.Field( + proto.STRING, + number=8, + ) + + +class ListBreakpointsResponse(proto.Message): + r"""Response for listing breakpoints. + + Attributes: + breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + next_wait_token: str = 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: str = proto.Field( + proto.STRING, + number=2, + ) + include_inactive: bool = proto.Field( + proto.BOOL, + number=3, + ) + client_version: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ListDebuggeesResponse(proto.Message): + r"""Response for listing debuggees. + + Attributes: + debuggees (MutableSequence[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: MutableSequence[data.Debuggee] = 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..574c5ae --- /dev/null +++ b/owl-bot-staging/v2/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +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..02ef930 --- /dev/null +++ b/owl-bot-staging/v2/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +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") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/debugger_v2/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +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=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + 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=DEFAULT_PYTHON_VERSION) +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", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py new file mode 100644 index 0000000..24f6ea0 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListActiveBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py new file mode 100644 index 0000000..67c27c7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListActiveBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py new file mode 100644 index 0000000..b0ac801 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDebuggee +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = await client.register_debuggee(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py new file mode 100644 index 0000000..99f6287 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDebuggee +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = client.register_debuggee(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py new file mode 100644 index 0000000..e74e3e7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateActiveBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py new file mode 100644 index 0000000..10a9948 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateActiveBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py new file mode 100644 index 0000000..b445c89 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + await client.delete_breakpoint(request=request) + + +# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py new file mode 100644 index 0000000..01599f2 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + client.delete_breakpoint(request=request) + + +# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py new file mode 100644 index 0000000..7074dcf --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.get_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py new file mode 100644 index 0000000..3f7ebd0 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.get_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py new file mode 100644 index 0000000..816dd2b --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py new file mode 100644 index 0000000..4f65108 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py new file mode 100644 index 0000000..fda422c --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListDebuggees +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_debuggees(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py new file mode 100644 index 0000000..246e83f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListDebuggees +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_debuggees(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py new file mode 100644 index 0000000..6267555 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.set_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py new file mode 100644 index 0000000..22b41d7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.set_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json new file mode 100644 index 0000000..ab6c88f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json @@ -0,0 +1,1369 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.devtools.clouddebugger.v2", + "version": "v2" + } + ], + "language": "PYTHON", + "name": "google-cloud-debugger-client", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.list_active_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "ListActiveBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", + "shortName": "list_active_breakpoints" + }, + "description": "Sample for ListActiveBreakpoints", + "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.list_active_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "ListActiveBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", + "shortName": "list_active_breakpoints" + }, + "description": "Sample for ListActiveBreakpoints", + "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.register_debuggee", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "RegisterDebuggee" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" + }, + { + "name": "debuggee", + "type": "google.cloud.debugger_v2.types.Debuggee" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", + "shortName": "register_debuggee" + }, + "description": "Sample for RegisterDebuggee", + "file": "clouddebugger_v2_generated_controller2_register_debuggee_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_register_debuggee_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.register_debuggee", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "RegisterDebuggee" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" + }, + { + "name": "debuggee", + "type": "google.cloud.debugger_v2.types.Debuggee" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", + "shortName": "register_debuggee" + }, + "description": "Sample for RegisterDebuggee", + "file": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.update_active_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "UpdateActiveBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", + "shortName": "update_active_breakpoint" + }, + "description": "Sample for UpdateActiveBreakpoint", + "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.update_active_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "UpdateActiveBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", + "shortName": "update_active_breakpoint" + }, + "description": "Sample for UpdateActiveBreakpoint", + "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.delete_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "DeleteBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_breakpoint" + }, + "description": "Sample for DeleteBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.delete_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "DeleteBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_breakpoint" + }, + "description": "Sample for DeleteBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.get_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "GetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", + "shortName": "get_breakpoint" + }, + "description": "Sample for GetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_async", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.get_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "GetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", + "shortName": "get_breakpoint" + }, + "description": "Sample for GetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", + "shortName": "list_breakpoints" + }, + "description": "Sample for ListBreakpoints", + "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.list_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", + "shortName": "list_breakpoints" + }, + "description": "Sample for ListBreakpoints", + "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_debuggees", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListDebuggees" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" + }, + { + "name": "project", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", + "shortName": "list_debuggees" + }, + "description": "Sample for ListDebuggees", + "file": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.list_debuggees", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListDebuggees" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" + }, + { + "name": "project", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", + "shortName": "list_debuggees" + }, + "description": "Sample for ListDebuggees", + "file": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.set_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "SetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", + "shortName": "set_breakpoint" + }, + "description": "Sample for SetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.set_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "SetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", + "shortName": "set_breakpoint" + }, + "description": "Sample for SetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py" + } + ] +} 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..9802c14 --- /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 2022 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..4295418 --- /dev/null +++ b/owl-bot-staging/v2/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-debugger-client' + + +description = "Google Cloud Debugger Client API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/debugger/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-debugger-client" + +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() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v2/testing/constraints-3.10.txt b/owl-bot-staging/v2/testing/constraints-3.10.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.11.txt b/owl-bot-staging/v2/testing/constraints-3.11.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.12.txt b/owl-bot-staging/v2/testing/constraints-3.12.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.7.txt b/owl-bot-staging/v2/testing/constraints-3.7.txt new file mode 100644 index 0000000..6c44adf --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v2/testing/constraints-3.8.txt b/owl-bot-staging/v2/testing/constraints-3.8.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.9.txt b/owl-bot-staging/v2/testing/constraints-3.9.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..5058381 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py @@ -0,0 +1,2551 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +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,transport_name", [ + (Controller2Client, "grpc"), + (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), +]) +def test_controller2_client_from_service_account_info(client_class, transport_name): + 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, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.Controller2GrpcTransport, "grpc"), + (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Controller2RestTransport, "rest"), +]) +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,transport_name", [ + (Controller2Client, "grpc"), + (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), +]) +def test_controller2_client_from_service_account_file(client_class, transport_name): + 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", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +def test_controller2_client_get_transport_class(): + transport = Controller2Client.get_transport_class() + available_transports = [ + transports.Controller2GrpcTransport, + transports.Controller2RestTransport, + ] + 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"), + (Controller2Client, transports.Controller2RestTransport, "rest"), +]) +@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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + 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=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@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"), + (Controller2Client, transports.Controller2RestTransport, "rest", "true"), + (Controller2Client, transports.Controller2RestTransport, "rest", "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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + +@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"), + (Controller2Client, transports.Controller2RestTransport, "rest"), +]) +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, + api_audience=None, + ) + +@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), + (Controller2Client, transports.Controller2RestTransport, "rest", None), +]) +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, + api_audience=None, + ) + +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, + api_audience=None, + ) + + +@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, + api_audience=None, + ) + + # 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_field_headers(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.ListActiveBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # 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: + call.return_value = controller.ListActiveBreakpointsResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_active_breakpoints_field_headers_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.ListActiveBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # 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: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.UpdateActiveBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint.id = 'id_value' + + # 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: + call.return_value = controller.UpdateActiveBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_active_breakpoint_field_headers_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.UpdateActiveBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint.id = 'id_value' + + # 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: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', + ) in kw['metadata'] + + +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'), + ) + + +@pytest.mark.parametrize("request_type", [ + controller.RegisterDebuggeeRequest, + dict, +]) +def test_register_debuggee_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.register_debuggee(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.RegisterDebuggeeResponse) + + +def test_register_debuggee_rest_required_fields(request_type=controller.RegisterDebuggeeRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.register_debuggee(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_register_debuggee_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.register_debuggee._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("debuggee", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_register_debuggee_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_register_debuggee") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_register_debuggee") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.RegisterDebuggeeRequest.pb(controller.RegisterDebuggeeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.RegisterDebuggeeResponse.to_json(controller.RegisterDebuggeeResponse()) + + request = controller.RegisterDebuggeeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.RegisterDebuggeeResponse() + + client.register_debuggee(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_register_debuggee_rest_bad_request(transport: str = 'rest', request_type=controller.RegisterDebuggeeRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.register_debuggee(request) + + +def test_register_debuggee_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + debuggee=data.Debuggee(id='id_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.register_debuggee(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/register" % client.transport._host, args[1]) + + +def test_register_debuggee_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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'), + ) + + +def test_register_debuggee_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + controller.ListActiveBreakpointsRequest, + dict, +]) +def test_list_active_breakpoints_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse( + next_wait_token='next_wait_token_value', + wait_expired=True, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_active_breakpoints(request) + + # 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_rest_required_fields(request_type=controller.ListActiveBreakpointsRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("success_on_timeout", "wait_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_active_breakpoints(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_active_breakpoints_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_active_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == (set(("successOnTimeout", "waitToken", )) & set(("debuggeeId", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_active_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_list_active_breakpoints") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_list_active_breakpoints") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.ListActiveBreakpointsRequest.pb(controller.ListActiveBreakpointsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.ListActiveBreakpointsResponse.to_json(controller.ListActiveBreakpointsResponse()) + + request = controller.ListActiveBreakpointsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.ListActiveBreakpointsResponse() + + client.list_active_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_active_breakpoints_rest_bad_request(transport: str = 'rest', request_type=controller.ListActiveBreakpointsRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_active_breakpoints(request) + + +def test_list_active_breakpoints_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_active_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) + + +def test_list_active_breakpoints_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_active_breakpoints_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + controller.UpdateActiveBreakpointRequest, + dict, +]) +def test_update_active_breakpoint_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_active_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.UpdateActiveBreakpointResponse) + + +def test_update_active_breakpoint_rest_required_fields(request_type=controller.UpdateActiveBreakpointRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "put", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_active_breakpoint(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_active_breakpoint_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_active_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("debuggeeId", "breakpoint", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_active_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_update_active_breakpoint") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_update_active_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.UpdateActiveBreakpointRequest.pb(controller.UpdateActiveBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.UpdateActiveBreakpointResponse.to_json(controller.UpdateActiveBreakpointResponse()) + + request = controller.UpdateActiveBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.UpdateActiveBreakpointResponse() + + client.update_active_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_active_breakpoint_rest_bad_request(transport: str = 'rest', request_type=controller.UpdateActiveBreakpointRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_active_breakpoint(request) + + +def test_update_active_breakpoint_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_active_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}" % client.transport._host, args[1]) + + +def test_update_active_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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'), + ) + + +def test_update_active_breakpoint_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +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, + transports.Controller2RestTransport, +]) +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() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = Controller2Client.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +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() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +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", + [ + transports.Controller2GrpcTransport, + transports.Controller2GrpcAsyncIOTransport, + transports.Controller2RestTransport, + ], +) +def test_controller2_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@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_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.Controller2RestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_controller2_host_no_port(transport_name): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_controller2_host_with_port(transport_name): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_controller2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Controller2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Controller2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.register_debuggee._session + session2 = client2.transport.register_debuggee._session + assert session1 != session2 + session1 = client1.transport.list_active_breakpoints._session + session2 = client2.transport.list_active_breakpoints._session + assert session1 != session2 + session1 = client1.transport.update_active_breakpoint._session + session2 = client2.transport.update_active_breakpoint._session + assert session1 != session2 +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 = { + "rest": "_session", + "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 = [ + 'rest', + '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, + api_audience=None, + ) 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..ad07b63 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py @@ -0,0 +1,3628 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +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,transport_name", [ + (Debugger2Client, "grpc"), + (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), +]) +def test_debugger2_client_from_service_account_info(client_class, transport_name): + 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, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.Debugger2GrpcTransport, "grpc"), + (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Debugger2RestTransport, "rest"), +]) +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,transport_name", [ + (Debugger2Client, "grpc"), + (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), +]) +def test_debugger2_client_from_service_account_file(client_class, transport_name): + 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", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +def test_debugger2_client_get_transport_class(): + transport = Debugger2Client.get_transport_class() + available_transports = [ + transports.Debugger2GrpcTransport, + transports.Debugger2RestTransport, + ] + 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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), +]) +@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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + 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=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "true"), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + +@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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), +]) +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, + api_audience=None, + ) + +@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), + (Debugger2Client, transports.Debugger2RestTransport, "rest", None), +]) +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, + api_audience=None, + ) + +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, + api_audience=None, + ) + + +@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, + api_audience=None, + ) + + # 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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.SetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + call.return_value = debugger.SetBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_set_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.SetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.GetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + call.return_value = debugger.GetBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.GetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.DeleteBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + call.return_value = None + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.DeleteBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.ListBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + call.return_value = debugger.ListBreakpointsResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_breakpoints_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.ListBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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', + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.SetBreakpointRequest, + dict, +]) +def test_set_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.set_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.SetBreakpointResponse) + + +def test_set_breakpoint_rest_required_fields(request_type=debugger.SetBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("breakpoint_", "client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.set_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_set_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.set_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("breakpoint", "clientVersion", )) & set(("debuggeeId", "breakpoint", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_set_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_set_breakpoint") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_set_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.SetBreakpointRequest.pb(debugger.SetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.SetBreakpointResponse.to_json(debugger.SetBreakpointResponse()) + + request = debugger.SetBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.SetBreakpointResponse() + + client.set_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_set_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.SetBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.set_breakpoint(request) + + +def test_set_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.set_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/set" % client.transport._host, args[1]) + + +def test_set_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_set_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.GetBreakpointRequest, + dict, +]) +def test_get_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.GetBreakpointResponse) + + +def test_get_breakpoint_rest_required_fields(request_type=debugger.GetBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["breakpointId"] = 'breakpoint_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == 'breakpoint_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_get_breakpoint") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_get_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.GetBreakpointRequest.pb(debugger.GetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.GetBreakpointResponse.to_json(debugger.GetBreakpointResponse()) + + request = debugger.GetBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.GetBreakpointResponse() + + client.get_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.GetBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_breakpoint(request) + + +def test_get_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) + + +def test_get_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_get_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.DeleteBreakpointRequest, + dict, +]) +def test_delete_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_breakpoint(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_breakpoint_rest_required_fields(request_type=debugger.DeleteBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["breakpointId"] = 'breakpoint_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == 'breakpoint_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_delete_breakpoint") as pre: + pre.assert_not_called() + pb_message = debugger.DeleteBreakpointRequest.pb(debugger.DeleteBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = debugger.DeleteBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_delete_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.DeleteBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_breakpoint(request) + + +def test_delete_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) + + +def test_delete_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_delete_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.ListBreakpointsRequest, + dict, +]) +def test_list_breakpoints_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse( + next_wait_token='next_wait_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_breakpoints(request) + + # 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_rest_required_fields(request_type=debugger.ListBreakpointsRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("action", "client_version", "include_all_users", "include_inactive", "strip_results", "wait_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_breakpoints(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_breakpoints_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == (set(("action", "clientVersion", "includeAllUsers", "includeInactive", "stripResults", "waitToken", )) & set(("debuggeeId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_list_breakpoints") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_breakpoints") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListBreakpointsRequest.pb(debugger.ListBreakpointsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListBreakpointsResponse.to_json(debugger.ListBreakpointsResponse()) + + request = debugger.ListBreakpointsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListBreakpointsResponse() + + client.list_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_breakpoints_rest_bad_request(transport: str = 'rest', request_type=debugger.ListBreakpointsRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_breakpoints(request) + + +def test_list_breakpoints_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) + + +def test_list_breakpoints_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_breakpoints_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.ListDebuggeesRequest, + dict, +]) +def test_list_debuggees_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_debuggees(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.ListDebuggeesResponse) + + +def test_list_debuggees_rest_required_fields(request_type=debugger.ListDebuggeesRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["project"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "project" not in jsonified_request + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "project" in jsonified_request + assert jsonified_request["project"] == request_init["project"] + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["project"] = 'project_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", "include_inactive", "project", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "project" in jsonified_request + assert jsonified_request["project"] == 'project_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_debuggees(request) + + expected_params = [ + ( + "project", + "", + ), + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_debuggees_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_debuggees._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", "includeInactive", "project", )) & set(("project", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_debuggees_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_list_debuggees") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_debuggees") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListDebuggeesRequest.pb(debugger.ListDebuggeesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListDebuggeesResponse.to_json(debugger.ListDebuggeesResponse()) + + request = debugger.ListDebuggeesRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListDebuggeesResponse() + + client.list_debuggees(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_debuggees_rest_bad_request(transport: str = 'rest', request_type=debugger.ListDebuggeesRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_debuggees(request) + + +def test_list_debuggees_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + project='project_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_debuggees(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees" % client.transport._host, args[1]) + + +def test_list_debuggees_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_debuggees_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +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, + transports.Debugger2RestTransport, +]) +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() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = Debugger2Client.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +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() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +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", + [ + transports.Debugger2GrpcTransport, + transports.Debugger2GrpcAsyncIOTransport, + transports.Debugger2RestTransport, + ], +) +def test_debugger2_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@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_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.Debugger2RestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_debugger2_host_no_port(transport_name): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_debugger2_host_with_port(transport_name): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_debugger2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Debugger2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Debugger2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.set_breakpoint._session + session2 = client2.transport.set_breakpoint._session + assert session1 != session2 + session1 = client1.transport.get_breakpoint._session + session2 = client2.transport.get_breakpoint._session + assert session1 != session2 + session1 = client1.transport.delete_breakpoint._session + session2 = client2.transport.delete_breakpoint._session + assert session1 != session2 + session1 = client1.transport.list_breakpoints._session + session2 = client2.transport.list_breakpoints._session + assert session1 != session2 + session1 = client1.transport.list_debuggees._session + session2 = client2.transport.list_debuggees._session + assert session1 != session2 +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 = { + "rest": "_session", + "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 = [ + 'rest', + '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, + api_audience=None, + ) From a417c1eb3e077b06e29bb7a86ae4fe00680e7053 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 22 Mar 2023 20:30:40 +0000 Subject: [PATCH 06/10] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20?= =?UTF-8?q?post-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- .../services/controller2/transports/rest.py | 1 - .../services/debugger2/transports/rest.py | 1 - owl-bot-staging/v2/.coveragerc | 13 - owl-bot-staging/v2/.flake8 | 33 - 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 | 6 - owl-bot-staging/v2/docs/index.rst | 7 - .../v2/google/cloud/debugger/__init__.py | 75 - .../v2/google/cloud/debugger/gapic_version.py | 16 - .../v2/google/cloud/debugger/py.typed | 2 - .../v2/google/cloud/debugger_v2/__init__.py | 76 - .../cloud/debugger_v2/gapic_metadata.json | 167 - .../google/cloud/debugger_v2/gapic_version.py | 16 - .../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 | 566 --- .../services/controller2/client.py | 747 ---- .../controller2/transports/__init__.py | 38 - .../services/controller2/transports/base.py | 191 - .../services/controller2/transports/grpc.py | 369 -- .../controller2/transports/grpc_asyncio.py | 368 -- .../services/controller2/transports/rest.py | 553 --- .../services/debugger2/__init__.py | 22 - .../services/debugger2/async_client.py | 806 ---- .../debugger_v2/services/debugger2/client.py | 973 ----- .../services/debugger2/transports/__init__.py | 38 - .../services/debugger2/transports/base.py | 234 -- .../services/debugger2/transports/grpc.py | 381 -- .../debugger2/transports/grpc_asyncio.py | 380 -- .../services/debugger2/transports/rest.py | 729 ---- .../cloud/debugger_v2/types/__init__.py | 68 - .../cloud/debugger_v2/types/controller.py | 176 - .../v2/google/cloud/debugger_v2/types/data.py | 681 ---- .../cloud/debugger_v2/types/debugger.py | 315 -- owl-bot-staging/v2/mypy.ini | 3 - owl-bot-staging/v2/noxfile.py | 184 - ...ntroller2_list_active_breakpoints_async.py | 52 - ...ontroller2_list_active_breakpoints_sync.py | 52 - ...ted_controller2_register_debuggee_async.py | 51 - ...ated_controller2_register_debuggee_sync.py | 51 - ...troller2_update_active_breakpoint_async.py | 52 - ...ntroller2_update_active_breakpoint_sync.py | 52 - ...rated_debugger2_delete_breakpoint_async.py | 52 - ...erated_debugger2_delete_breakpoint_sync.py | 52 - ...enerated_debugger2_get_breakpoint_async.py | 54 - ...generated_debugger2_get_breakpoint_sync.py | 54 - ...erated_debugger2_list_breakpoints_async.py | 53 - ...nerated_debugger2_list_breakpoints_sync.py | 53 - ...enerated_debugger2_list_debuggees_async.py | 53 - ...generated_debugger2_list_debuggees_sync.py | 53 - ...enerated_debugger2_set_breakpoint_async.py | 53 - ...generated_debugger2_set_breakpoint_sync.py | 53 - ...data_google.devtools.clouddebugger.v2.json | 1369 ------- .../v2/scripts/fixup_debugger_v2_keywords.py | 183 - owl-bot-staging/v2/setup.py | 90 - .../v2/testing/constraints-3.10.txt | 6 - .../v2/testing/constraints-3.11.txt | 6 - .../v2/testing/constraints-3.12.txt | 6 - .../v2/testing/constraints-3.7.txt | 9 - .../v2/testing/constraints-3.8.txt | 6 - .../v2/testing/constraints-3.9.txt | 6 - 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 | 2551 ------------ .../unit/gapic/debugger_v2/test_debugger2.py | 3628 ----------------- 73 files changed, 17484 deletions(-) delete mode 100644 owl-bot-staging/v2/.coveragerc delete mode 100644 owl-bot-staging/v2/.flake8 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/gapic_version.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/gapic_version.py 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/controller2/transports/rest.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/services/debugger2/transports/rest.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/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json 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/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.9.txt 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/transports/rest.py b/google/cloud/debugger_v2/services/controller2/transports/rest.py index fd102b7..8ad8203 100644 --- a/google/cloud/debugger_v2/services/controller2/transports/rest.py +++ b/google/cloud/debugger_v2/services/controller2/transports/rest.py @@ -495,7 +495,6 @@ def __call__( request (~.controller.UpdateActiveBreakpointRequest): The request object. Request to update an active breakpoint. - retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. diff --git a/google/cloud/debugger_v2/services/debugger2/transports/rest.py b/google/cloud/debugger_v2/services/debugger2/transports/rest.py index e2cebab..56ed52e 100644 --- a/google/cloud/debugger_v2/services/debugger2/transports/rest.py +++ b/google/cloud/debugger_v2/services/debugger2/transports/rest.py @@ -428,7 +428,6 @@ def __call__( request (~.debugger.GetBreakpointRequest): The request object. Request to get breakpoint information. - retry (google.api_core.retry.Retry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. diff --git a/owl-bot-staging/v2/.coveragerc b/owl-bot-staging/v2/.coveragerc deleted file mode 100644 index 9620812..0000000 --- a/owl-bot-staging/v2/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/debugger/__init__.py - google/cloud/debugger/gapic_version.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ diff --git a/owl-bot-staging/v2/.flake8 b/owl-bot-staging/v2/.flake8 deleted file mode 100644 index 29227d4..0000000 --- a/owl-bot-staging/v2/.flake8 +++ /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 -# -# https://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. - -# Generated by synthtool. DO NOT EDIT! -[flake8] -ignore = E203, E266, E501, W503 -exclude = - # Exclude generated code. - **/proto/** - **/gapic/** - **/services/** - **/types/** - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py 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 4ad5ea1..0000000 --- a/owl-bot-staging/v2/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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"2022, 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 0106467..0000000 --- a/owl-bot-staging/v2/docs/debugger_v2/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Debugger v2 API -====================================== - -.. automodule:: google.cloud.debugger_v2.types - :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 1228468..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger/__init__.py +++ /dev/null @@ -1,75 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 import gapic_version as package_version - -__version__ = package_version.__version__ - - -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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -__version__ = "0.1.0" # {x-release-please-version} 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 c774017..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py +++ /dev/null @@ -1,76 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 import gapic_version as package_version - -__version__ = package_version.__version__ - - -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 f0d8a90..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json +++ /dev/null @@ -1,167 +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" - ] - } - } - }, - "rest": { - "libraryClient": "Controller2Client", - "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" - ] - } - } - }, - "rest": { - "libraryClient": "Debugger2Client", - "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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py deleted file mode 100644 index 405b1ce..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -__version__ = "0.1.0" # {x-release-please-version} 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 e8e1c38..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 e010a73..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 aa29878..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py +++ /dev/null @@ -1,566 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 variable 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: Optional[ga_credentials.Credentials] = None, - transport: Union[str, Controller2Transport] = "grpc_asyncio", - client_options: Optional[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: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, - *, - debuggee: Optional[data.Debuggee] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = await client.register_debuggee(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint.id", request.breakpoint.id), - )), - ) - - # 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() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 7330718..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py +++ /dev/null @@ -1,747 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 -from .transports.rest import Controller2RestTransport - - -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 - _transport_registry["rest"] = Controller2RestTransport - - def get_transport_class(cls, - label: Optional[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 variable 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: Optional[Union[str, Controller2Transport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() - client_options = cast(client_options_lib.ClientOptions, client_options) - - 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, - api_audience=client_options.api_audience, - ) - - def register_debuggee(self, - request: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, - *, - debuggee: Optional[data.Debuggee] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = client.register_debuggee(request=request) - - # Handle the response - print(response) - - 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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_active_breakpoint(self, - request: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint.id", request.breakpoint.id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "Controller2Client": - 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() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 0381ff4..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -from .rest import Controller2RestTransport -from .rest import Controller2RestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] -_transport_registry['grpc'] = Controller2GrpcTransport -_transport_registry['grpc_asyncio'] = Controller2GrpcAsyncIOTransport -_transport_registry['rest'] = Controller2RestTransport - -__all__ = ( - 'Controller2Transport', - 'Controller2GrpcTransport', - 'Controller2GrpcAsyncIOTransport', - 'Controller2RestTransport', - 'Controller2RestInterceptor', -) 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 8e480a6..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py +++ /dev/null @@ -1,191 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -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: Optional[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, - api_audience: Optional[str] = None, - **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. - """ - - 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) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # 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 - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - 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() - - @property - def kind(self) -> str: - 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 09e2efa..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py +++ /dev/null @@ -1,369 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[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() - - @property - def kind(self) -> str: - return "grpc" - - -__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 ae65db1..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py +++ /dev/null @@ -1,368 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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/controller2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py deleted file mode 100644 index e172241..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py +++ /dev/null @@ -1,553 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -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 .base import Controller2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class Controller2RestInterceptor: - """Interceptor for Controller2. - - Interceptors are used to manipulate requests, request metadata, and responses - in arbitrary ways. - Example use cases include: - * Logging - * Verifying requests according to service or custom semantics - * Stripping extraneous information from responses - - These use cases and more can be enabled by injecting an - instance of a custom subclass when constructing the Controller2RestTransport. - - .. code-block:: python - class MyCustomController2Interceptor(Controller2RestInterceptor): - def pre_list_active_breakpoints(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_active_breakpoints(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_register_debuggee(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_register_debuggee(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_active_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_active_breakpoint(self, response): - logging.log(f"Received response: {response}") - return response - - transport = Controller2RestTransport(interceptor=MyCustomController2Interceptor()) - client = Controller2Client(transport=transport) - - - """ - def pre_list_active_breakpoints(self, request: controller.ListActiveBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.ListActiveBreakpointsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_active_breakpoints - - Override in a subclass to manipulate the request or metadata - before they are sent to the Controller2 server. - """ - return request, metadata - - def post_list_active_breakpoints(self, response: controller.ListActiveBreakpointsResponse) -> controller.ListActiveBreakpointsResponse: - """Post-rpc interceptor for list_active_breakpoints - - Override in a subclass to manipulate the response - after it is returned by the Controller2 server but before - it is returned to user code. - """ - return response - def pre_register_debuggee(self, request: controller.RegisterDebuggeeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.RegisterDebuggeeRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for register_debuggee - - Override in a subclass to manipulate the request or metadata - before they are sent to the Controller2 server. - """ - return request, metadata - - def post_register_debuggee(self, response: controller.RegisterDebuggeeResponse) -> controller.RegisterDebuggeeResponse: - """Post-rpc interceptor for register_debuggee - - Override in a subclass to manipulate the response - after it is returned by the Controller2 server but before - it is returned to user code. - """ - return response - def pre_update_active_breakpoint(self, request: controller.UpdateActiveBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.UpdateActiveBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for update_active_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Controller2 server. - """ - return request, metadata - - def post_update_active_breakpoint(self, response: controller.UpdateActiveBreakpointResponse) -> controller.UpdateActiveBreakpointResponse: - """Post-rpc interceptor for update_active_breakpoint - - Override in a subclass to manipulate the response - after it is returned by the Controller2 server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class Controller2RestStub: - _session: AuthorizedSession - _host: str - _interceptor: Controller2RestInterceptor - - -class Controller2RestTransport(Controller2Transport): - """REST 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 JSON representations of protocol buffers over HTTP/1.1 - - """ - - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[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, - url_scheme: str = 'https', - interceptor: Optional[Controller2RestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> 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 ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` 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 are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or Controller2RestInterceptor() - self._prep_wrapped_messages(client_info) - - class _ListActiveBreakpoints(Controller2RestStub): - def __hash__(self): - return hash("ListActiveBreakpoints") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.ListActiveBreakpointsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.ListActiveBreakpointsResponse: - r"""Call the list active breakpoints method over HTTP. - - Args: - request (~.controller.ListActiveBreakpointsRequest): - The request object. Request to list active breakpoints. - 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: - ~.controller.ListActiveBreakpointsResponse: - Response for listing active - breakpoints. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints', - }, - ] - request, metadata = self._interceptor.pre_list_active_breakpoints(request, metadata) - pb_request = controller.ListActiveBreakpointsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = controller.ListActiveBreakpointsResponse() - pb_resp = controller.ListActiveBreakpointsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_active_breakpoints(resp) - return resp - - class _RegisterDebuggee(Controller2RestStub): - def __hash__(self): - return hash("RegisterDebuggee") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.RegisterDebuggeeRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.RegisterDebuggeeResponse: - r"""Call the register debuggee method over HTTP. - - Args: - request (~.controller.RegisterDebuggeeRequest): - The request object. Request to register a debuggee. - 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: - ~.controller.RegisterDebuggeeResponse: - Response for registering a debuggee. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v2/controller/debuggees/register', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_register_debuggee(request, metadata) - pb_request = controller.RegisterDebuggeeRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = controller.RegisterDebuggeeResponse() - pb_resp = controller.RegisterDebuggeeResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_register_debuggee(resp) - return resp - - class _UpdateActiveBreakpoint(Controller2RestStub): - def __hash__(self): - return hash("UpdateActiveBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.UpdateActiveBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.UpdateActiveBreakpointResponse: - r"""Call the update active breakpoint method over HTTP. - - Args: - request (~.controller.UpdateActiveBreakpointRequest): - The request object. Request to update an active - breakpoint. - 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: - ~.controller.UpdateActiveBreakpointResponse: - Response for updating an active - breakpoint. The message is defined to - allow future extensions. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'put', - 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_update_active_breakpoint(request, metadata) - pb_request = controller.UpdateActiveBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = controller.UpdateActiveBreakpointResponse() - pb_resp = controller.UpdateActiveBreakpointResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_update_active_breakpoint(resp) - return resp - - @property - def list_active_breakpoints(self) -> Callable[ - [controller.ListActiveBreakpointsRequest], - controller.ListActiveBreakpointsResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListActiveBreakpoints(self._session, self._host, self._interceptor) # type: ignore - - @property - def register_debuggee(self) -> Callable[ - [controller.RegisterDebuggeeRequest], - controller.RegisterDebuggeeResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._RegisterDebuggee(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_active_breakpoint(self) -> Callable[ - [controller.UpdateActiveBreakpointRequest], - controller.UpdateActiveBreakpointResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._UpdateActiveBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'Controller2RestTransport', -) 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 5d7f609..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 257c378..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py +++ /dev/null @@ -1,806 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 variable 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: Optional[ga_credentials.Credentials] = None, - transport: Union[str, Debugger2Transport] = "grpc_asyncio", - client_options: Optional[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: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.SetBreakpointResponse: - r"""Sets the breakpoint to the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.set_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.GetBreakpointResponse: - r"""Gets breakpoint information. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.get_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # 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: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the breakpoint from the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - await client.delete_breakpoint(request=request) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def list_breakpoints(self, - request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListBreakpointsResponse: - r"""Lists all breakpoints for the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_breakpoints(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, - *, - project: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListDebuggeesResponse: - r"""Lists all the debuggees that the user has access to. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_debuggees(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 7e52f8d..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py +++ /dev/null @@ -1,973 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 -from .transports.rest import Debugger2RestTransport - - -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 - _transport_registry["rest"] = Debugger2RestTransport - - def get_transport_class(cls, - label: Optional[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 variable 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: Optional[Union[str, Debugger2Transport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() - client_options = cast(client_options_lib.ClientOptions, client_options) - - 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, - api_audience=client_options.api_audience, - ) - - def set_breakpoint(self, - request: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.SetBreakpointResponse: - r"""Sets the breakpoint to the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.set_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_breakpoint(self, - request: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.GetBreakpointResponse: - r"""Gets breakpoint information. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.get_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_breakpoint(self, - request: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the breakpoint from the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - client.delete_breakpoint(request=request) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def list_breakpoints(self, - request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListBreakpointsResponse: - r"""Lists all breakpoints for the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_breakpoints(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_debuggees(self, - request: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, - *, - project: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListDebuggeesResponse: - r"""Lists all the debuggees that the user has access to. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_debuggees(request=request) - - # Handle the response - print(response) - - 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) -> "Debugger2Client": - 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() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 cd9dd46..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -from .rest import Debugger2RestTransport -from .rest import Debugger2RestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] -_transport_registry['grpc'] = Debugger2GrpcTransport -_transport_registry['grpc_asyncio'] = Debugger2GrpcAsyncIOTransport -_transport_registry['rest'] = Debugger2RestTransport - -__all__ = ( - 'Debugger2Transport', - 'Debugger2GrpcTransport', - 'Debugger2GrpcAsyncIOTransport', - 'Debugger2RestTransport', - 'Debugger2RestInterceptor', -) 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 c4afc0c..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py +++ /dev/null @@ -1,234 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -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: Optional[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, - api_audience: Optional[str] = None, - **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. - """ - - 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) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # 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 - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - 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() - - @property - def kind(self) -> str: - 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 fbb3374..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py +++ /dev/null @@ -1,381 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[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() - - @property - def kind(self) -> str: - return "grpc" - - -__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 eb6eadc..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py +++ /dev/null @@ -1,380 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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/services/debugger2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py deleted file mode 100644 index 63388ac..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py +++ /dev/null @@ -1,729 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -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 debugger -from google.protobuf import empty_pb2 # type: ignore - -from .base import Debugger2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class Debugger2RestInterceptor: - """Interceptor for Debugger2. - - Interceptors are used to manipulate requests, request metadata, and responses - in arbitrary ways. - Example use cases include: - * Logging - * Verifying requests according to service or custom semantics - * Stripping extraneous information from responses - - These use cases and more can be enabled by injecting an - instance of a custom subclass when constructing the Debugger2RestTransport. - - .. code-block:: python - class MyCustomDebugger2Interceptor(Debugger2RestInterceptor): - def pre_delete_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def pre_get_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_breakpoint(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_breakpoints(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_breakpoints(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_debuggees(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_debuggees(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_set_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_set_breakpoint(self, response): - logging.log(f"Received response: {response}") - return response - - transport = Debugger2RestTransport(interceptor=MyCustomDebugger2Interceptor()) - client = Debugger2Client(transport=transport) - - - """ - def pre_delete_breakpoint(self, request: debugger.DeleteBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.DeleteBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for delete_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def pre_get_breakpoint(self, request: debugger.GetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.GetBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_get_breakpoint(self, response: debugger.GetBreakpointResponse) -> debugger.GetBreakpointResponse: - """Post-rpc interceptor for get_breakpoint - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - def pre_list_breakpoints(self, request: debugger.ListBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListBreakpointsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_breakpoints - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_list_breakpoints(self, response: debugger.ListBreakpointsResponse) -> debugger.ListBreakpointsResponse: - """Post-rpc interceptor for list_breakpoints - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - def pre_list_debuggees(self, request: debugger.ListDebuggeesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListDebuggeesRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_debuggees - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_list_debuggees(self, response: debugger.ListDebuggeesResponse) -> debugger.ListDebuggeesResponse: - """Post-rpc interceptor for list_debuggees - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - def pre_set_breakpoint(self, request: debugger.SetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.SetBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for set_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_set_breakpoint(self, response: debugger.SetBreakpointResponse) -> debugger.SetBreakpointResponse: - """Post-rpc interceptor for set_breakpoint - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class Debugger2RestStub: - _session: AuthorizedSession - _host: str - _interceptor: Debugger2RestInterceptor - - -class Debugger2RestTransport(Debugger2Transport): - """REST 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 JSON representations of protocol buffers over HTTP/1.1 - - """ - - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[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, - url_scheme: str = 'https', - interceptor: Optional[Debugger2RestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> 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 ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` 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 are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or Debugger2RestInterceptor() - self._prep_wrapped_messages(client_info) - - class _DeleteBreakpoint(Debugger2RestStub): - def __hash__(self): - return hash("DeleteBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.DeleteBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ): - r"""Call the delete breakpoint method over HTTP. - - Args: - request (~.debugger.DeleteBreakpointRequest): - The request object. Request to delete a breakpoint. - 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. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', - }, - ] - request, metadata = self._interceptor.pre_delete_breakpoint(request, metadata) - pb_request = debugger.DeleteBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - class _GetBreakpoint(Debugger2RestStub): - def __hash__(self): - return hash("GetBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.GetBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.GetBreakpointResponse: - r"""Call the get breakpoint method over HTTP. - - Args: - request (~.debugger.GetBreakpointRequest): - The request object. Request to get breakpoint - information. - 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: - ~.debugger.GetBreakpointResponse: - Response for getting breakpoint - information. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', - }, - ] - request, metadata = self._interceptor.pre_get_breakpoint(request, metadata) - pb_request = debugger.GetBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.GetBreakpointResponse() - pb_resp = debugger.GetBreakpointResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_breakpoint(resp) - return resp - - class _ListBreakpoints(Debugger2RestStub): - def __hash__(self): - return hash("ListBreakpoints") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.ListBreakpointsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.ListBreakpointsResponse: - r"""Call the list breakpoints method over HTTP. - - Args: - request (~.debugger.ListBreakpointsRequest): - The request object. Request to list breakpoints. - 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: - ~.debugger.ListBreakpointsResponse: - Response for listing breakpoints. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints', - }, - ] - request, metadata = self._interceptor.pre_list_breakpoints(request, metadata) - pb_request = debugger.ListBreakpointsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.ListBreakpointsResponse() - pb_resp = debugger.ListBreakpointsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_breakpoints(resp) - return resp - - class _ListDebuggees(Debugger2RestStub): - def __hash__(self): - return hash("ListDebuggees") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "project" : "", "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.ListDebuggeesRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.ListDebuggeesResponse: - r"""Call the list debuggees method over HTTP. - - Args: - request (~.debugger.ListDebuggeesRequest): - The request object. Request to list debuggees. - 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: - ~.debugger.ListDebuggeesResponse: - Response for listing debuggees. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees', - }, - ] - request, metadata = self._interceptor.pre_list_debuggees(request, metadata) - pb_request = debugger.ListDebuggeesRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.ListDebuggeesResponse() - pb_resp = debugger.ListDebuggeesResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_debuggees(resp) - return resp - - class _SetBreakpoint(Debugger2RestStub): - def __hash__(self): - return hash("SetBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "breakpoint" : {}, "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.SetBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.SetBreakpointResponse: - r"""Call the set breakpoint method over HTTP. - - Args: - request (~.debugger.SetBreakpointRequest): - The request object. Request to set a breakpoint - 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: - ~.debugger.SetBreakpointResponse: - Response for setting a breakpoint. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/set', - 'body': 'breakpoint', - }, - ] - request, metadata = self._interceptor.pre_set_breakpoint(request, metadata) - pb_request = debugger.SetBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.SetBreakpointResponse() - pb_resp = debugger.SetBreakpointResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_set_breakpoint(resp) - return resp - - @property - def delete_breakpoint(self) -> Callable[ - [debugger.DeleteBreakpointRequest], - empty_pb2.Empty]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._DeleteBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_breakpoint(self) -> Callable[ - [debugger.GetBreakpointRequest], - debugger.GetBreakpointResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._GetBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_breakpoints(self) -> Callable[ - [debugger.ListBreakpointsRequest], - debugger.ListBreakpointsResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListBreakpoints(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_debuggees(self) -> Callable[ - [debugger.ListDebuggeesRequest], - debugger.ListDebuggeesResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListDebuggees(self._session, self._host, self._interceptor) # type: ignore - - @property - def set_breakpoint(self) -> Callable[ - [debugger.SetBreakpointRequest], - debugger.SetBreakpointResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._SetBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'Debugger2RestTransport', -) 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 9791b6c..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py +++ /dev/null @@ -1,68 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 2ed0286..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py +++ /dev/null @@ -1,176 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -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: data.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: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - wait_token: str = proto.Field( - proto.STRING, - number=2, - ) - success_on_timeout: bool = proto.Field( - proto.BOOL, - number=3, - ) - - -class ListActiveBreakpointsResponse(proto.Message): - r"""Response for listing active breakpoints. - - Attributes: - breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - next_wait_token: str = proto.Field( - proto.STRING, - number=2, - ) - wait_expired: bool = 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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_: data.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 42e4206..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py +++ /dev/null @@ -1,681 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -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 (MutableSequence[str]): - Optional parameters to be embedded into the - message. - """ - - format_: str = proto.Field( - proto.STRING, - number=1, - ) - parameters: MutableSequence[str] = 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. - - Values: - UNSPECIFIED (0): - Status doesn't refer to any particular input. - BREAKPOINT_SOURCE_LOCATION (3): - Status applies to the breakpoint and is - related to its location. - BREAKPOINT_CONDITION (4): - Status applies to the breakpoint and is - related to its condition. - BREAKPOINT_EXPRESSION (7): - Status applies to the breakpoint and is - related to its expressions. - BREAKPOINT_AGE (8): - Status applies to the breakpoint and is - related to its age. - VARIABLE_NAME (5): - Status applies to the entire variable. - VARIABLE_VALUE (6): - Status applies to variable value (variable - name is valid). - """ - UNSPECIFIED = 0 - BREAKPOINT_SOURCE_LOCATION = 3 - BREAKPOINT_CONDITION = 4 - BREAKPOINT_EXPRESSION = 7 - BREAKPOINT_AGE = 8 - VARIABLE_NAME = 5 - VARIABLE_VALUE = 6 - - is_error: bool = proto.Field( - proto.BOOL, - number=1, - ) - refers_to: Reference = proto.Field( - proto.ENUM, - number=2, - enum=Reference, - ) - description: 'FormatMessage' = 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: str = proto.Field( - proto.STRING, - number=1, - ) - line: int = proto.Field( - proto.INT32, - number=2, - ) - column: int = 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 (MutableSequence[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: str = proto.Field( - proto.STRING, - number=1, - ) - value: str = proto.Field( - proto.STRING, - number=2, - ) - type_: str = proto.Field( - proto.STRING, - number=6, - ) - members: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Variable', - ) - var_table_index: wrappers_pb2.Int32Value = proto.Field( - proto.MESSAGE, - number=4, - message=wrappers_pb2.Int32Value, - ) - status: 'StatusMessage' = 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 (MutableSequence[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_ (MutableSequence[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: str = proto.Field( - proto.STRING, - number=1, - ) - location: 'SourceLocation' = proto.Field( - proto.MESSAGE, - number=2, - message='SourceLocation', - ) - arguments: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Variable', - ) - locals_: MutableSequence['Variable'] = 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 (MutableSequence[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 (MutableSequence[google.cloud.debugger_v2.types.StackFrame]): - The stack at breakpoint time, where stack_frames[0] - represents the most recently entered function. - evaluated_expressions (MutableSequence[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 (MutableSequence[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 (MutableMapping[str, str]): - 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. - - Values: - CAPTURE (0): - Capture stack frame and variables and update - the breakpoint. The data is only captured once. - After that the breakpoint is set in a final - state. - LOG (1): - Log each breakpoint hit. The breakpoint - remains active until deleted or expired. - """ - CAPTURE = 0 - LOG = 1 - - class LogLevel(proto.Enum): - r"""Log severity levels. - - Values: - INFO (0): - Information log message. - WARNING (1): - Warning log message. - ERROR (2): - Error log message. - """ - INFO = 0 - WARNING = 1 - ERROR = 2 - - id: str = proto.Field( - proto.STRING, - number=1, - ) - action: Action = proto.Field( - proto.ENUM, - number=13, - enum=Action, - ) - location: 'SourceLocation' = proto.Field( - proto.MESSAGE, - number=2, - message='SourceLocation', - ) - condition: str = proto.Field( - proto.STRING, - number=3, - ) - expressions: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=4, - ) - log_message_format: str = proto.Field( - proto.STRING, - number=14, - ) - log_level: LogLevel = proto.Field( - proto.ENUM, - number=15, - enum=LogLevel, - ) - is_final_state: bool = proto.Field( - proto.BOOL, - number=5, - ) - create_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=11, - message=timestamp_pb2.Timestamp, - ) - final_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=12, - message=timestamp_pb2.Timestamp, - ) - user_email: str = proto.Field( - proto.STRING, - number=16, - ) - status: 'StatusMessage' = proto.Field( - proto.MESSAGE, - number=10, - message='StatusMessage', - ) - stack_frames: MutableSequence['StackFrame'] = proto.RepeatedField( - proto.MESSAGE, - number=7, - message='StackFrame', - ) - evaluated_expressions: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=8, - message='Variable', - ) - variable_table: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=9, - message='Variable', - ) - labels: MutableMapping[str, str] = 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 (MutableSequence[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 (MutableSequence[google.devtools.source.v1.source_context_pb2.ExtendedSourceContext]): - References to the locations and revisions of - the source code used in the deployed - application. - labels (MutableMapping[str, str]): - A set of custom debuggee properties, - populated by the agent, to be displayed to the - user. - """ - - id: str = proto.Field( - proto.STRING, - number=1, - ) - project: str = proto.Field( - proto.STRING, - number=2, - ) - uniquifier: str = proto.Field( - proto.STRING, - number=3, - ) - description: str = proto.Field( - proto.STRING, - number=4, - ) - is_inactive: bool = proto.Field( - proto.BOOL, - number=5, - ) - agent_version: str = proto.Field( - proto.STRING, - number=6, - ) - is_disabled: bool = proto.Field( - proto.BOOL, - number=7, - ) - status: 'StatusMessage' = proto.Field( - proto.MESSAGE, - number=8, - message='StatusMessage', - ) - source_contexts: MutableSequence[source_context_pb2.SourceContext] = proto.RepeatedField( - proto.MESSAGE, - number=9, - message=source_context_pb2.SourceContext, - ) - ext_source_contexts: MutableSequence[source_context_pb2.ExtendedSourceContext] = proto.RepeatedField( - proto.MESSAGE, - number=13, - message=source_context_pb2.ExtendedSourceContext, - ) - labels: MutableMapping[str, str] = 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 0c2fa0a..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py +++ /dev/null @@ -1,315 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_: data.Breakpoint = proto.Field( - proto.MESSAGE, - number=2, - message=data.Breakpoint, - ) - client_version: str = 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_: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_id: str = proto.Field( - proto.STRING, - number=2, - ) - client_version: str = 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_: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_id: str = proto.Field( - proto.STRING, - number=2, - ) - client_version: str = 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: data.Breakpoint.Action = proto.Field( - proto.ENUM, - number=1, - enum=data.Breakpoint.Action, - ) - - debuggee_id: str = proto.Field( - proto.STRING, - number=1, - ) - include_all_users: bool = proto.Field( - proto.BOOL, - number=2, - ) - include_inactive: bool = proto.Field( - proto.BOOL, - number=3, - ) - action: BreakpointActionValue = proto.Field( - proto.MESSAGE, - number=4, - message=BreakpointActionValue, - ) - strip_results: bool = proto.Field( - proto.BOOL, - number=5, - ) - wait_token: str = proto.Field( - proto.STRING, - number=6, - ) - client_version: str = proto.Field( - proto.STRING, - number=8, - ) - - -class ListBreakpointsResponse(proto.Message): - r"""Response for listing breakpoints. - - Attributes: - breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - next_wait_token: str = 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: str = proto.Field( - proto.STRING, - number=2, - ) - include_inactive: bool = proto.Field( - proto.BOOL, - number=3, - ) - client_version: str = proto.Field( - proto.STRING, - number=4, - ) - - -class ListDebuggeesResponse(proto.Message): - r"""Response for listing debuggees. - - Attributes: - debuggees (MutableSequence[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: MutableSequence[data.Debuggee] = 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 574c5ae..0000000 --- a/owl-bot-staging/v2/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/v2/noxfile.py b/owl-bot-staging/v2/noxfile.py deleted file mode 100644 index 02ef930..0000000 --- a/owl-bot-staging/v2/noxfile.py +++ /dev/null @@ -1,184 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", -] - -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") - -BLACK_VERSION = "black==22.3.0" -BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] -DEFAULT_PYTHON_VERSION = "3.11" - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", - "blacken", - "lint", - "lint_setup_py", -] - -@nox.session(python=ALL_PYTHON) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/debugger_v2/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -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=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - 'mypy', - 'types-requests', - 'types-protobuf' - ) - 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=DEFAULT_PYTHON_VERSION) -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", ""), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint(session): - """Run linters. - - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install("flake8", BLACK_VERSION) - session.run( - "black", - "--check", - *BLACK_PATHS, - ) - session.run("flake8", "google", "tests", "samples") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *BLACK_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py deleted file mode 100644 index 24f6ea0..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListActiveBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py deleted file mode 100644 index 67c27c7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListActiveBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py deleted file mode 100644 index b0ac801..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDebuggee -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = await client.register_debuggee(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py deleted file mode 100644 index 99f6287..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDebuggee -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = client.register_debuggee(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py deleted file mode 100644 index e74e3e7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateActiveBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py deleted file mode 100644 index 10a9948..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateActiveBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py deleted file mode 100644 index b445c89..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - await client.delete_breakpoint(request=request) - - -# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py deleted file mode 100644 index 01599f2..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - client.delete_breakpoint(request=request) - - -# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py deleted file mode 100644 index 7074dcf..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.get_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py deleted file mode 100644 index 3f7ebd0..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.get_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py deleted file mode 100644 index 816dd2b..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py deleted file mode 100644 index 4f65108..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py deleted file mode 100644 index fda422c..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListDebuggees -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_debuggees(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py deleted file mode 100644 index 246e83f..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListDebuggees -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_debuggees(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py deleted file mode 100644 index 6267555..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.set_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py deleted file mode 100644 index 22b41d7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.set_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json deleted file mode 100644 index ab6c88f..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json +++ /dev/null @@ -1,1369 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.devtools.clouddebugger.v2", - "version": "v2" - } - ], - "language": "PYTHON", - "name": "google-cloud-debugger-client", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.list_active_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "ListActiveBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", - "shortName": "list_active_breakpoints" - }, - "description": "Sample for ListActiveBreakpoints", - "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.list_active_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "ListActiveBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", - "shortName": "list_active_breakpoints" - }, - "description": "Sample for ListActiveBreakpoints", - "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.register_debuggee", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "RegisterDebuggee" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" - }, - { - "name": "debuggee", - "type": "google.cloud.debugger_v2.types.Debuggee" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", - "shortName": "register_debuggee" - }, - "description": "Sample for RegisterDebuggee", - "file": "clouddebugger_v2_generated_controller2_register_debuggee_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_async", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_register_debuggee_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.register_debuggee", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "RegisterDebuggee" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" - }, - { - "name": "debuggee", - "type": "google.cloud.debugger_v2.types.Debuggee" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", - "shortName": "register_debuggee" - }, - "description": "Sample for RegisterDebuggee", - "file": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.update_active_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "UpdateActiveBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", - "shortName": "update_active_breakpoint" - }, - "description": "Sample for UpdateActiveBreakpoint", - "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.update_active_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "UpdateActiveBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", - "shortName": "update_active_breakpoint" - }, - "description": "Sample for UpdateActiveBreakpoint", - "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.delete_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "DeleteBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_breakpoint" - }, - "description": "Sample for DeleteBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.delete_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "DeleteBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_breakpoint" - }, - "description": "Sample for DeleteBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.get_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "GetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", - "shortName": "get_breakpoint" - }, - "description": "Sample for GetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_async", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.get_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "GetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", - "shortName": "get_breakpoint" - }, - "description": "Sample for GetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", - "shortName": "list_breakpoints" - }, - "description": "Sample for ListBreakpoints", - "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.list_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", - "shortName": "list_breakpoints" - }, - "description": "Sample for ListBreakpoints", - "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_debuggees", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListDebuggees" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" - }, - { - "name": "project", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", - "shortName": "list_debuggees" - }, - "description": "Sample for ListDebuggees", - "file": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.list_debuggees", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListDebuggees" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" - }, - { - "name": "project", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", - "shortName": "list_debuggees" - }, - "description": "Sample for ListDebuggees", - "file": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.set_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "SetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", - "shortName": "set_breakpoint" - }, - "description": "Sample for SetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.set_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "SetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", - "shortName": "set_breakpoint" - }, - "description": "Sample for SetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py" - } - ] -} 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 9802c14..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 2022 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 4295418..0000000 --- a/owl-bot-staging/v2/setup.py +++ /dev/null @@ -1,90 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-cloud-debugger-client' - - -description = "Google Cloud Debugger Client API client library" - -version = {} -with open(os.path.join(package_root, 'google/cloud/debugger/gapic_version.py')) as fp: - exec(fp.read(), version) -version = version["__version__"] - -if version[0] == "0": - release_status = "Development Status :: 4 - Beta" -else: - release_status = "Development Status :: 5 - Production/Stable" - -dependencies = [ - "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - "proto-plus >= 1.22.0, <2.0.0dev", - "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", - "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", -] -url = "https://github.com/googleapis/python-debugger-client" - -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() - -packages = [ - package - for package in setuptools.PEP420PackageFinder.find() - if package.startswith("google") -] - -namespaces = ["google", "google.cloud"] - -setuptools.setup( - name=name, - version=version, - description=description, - long_description=readme, - author="Google LLC", - author_email="googleapis-packages@google.com", - license="Apache 2.0", - url=url, - classifiers=[ - release_status, - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - namespace_packages=namespaces, - install_requires=dependencies, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/v2/testing/constraints-3.10.txt b/owl-bot-staging/v2/testing/constraints-3.10.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.10.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.11.txt b/owl-bot-staging/v2/testing/constraints-3.11.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.11.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.12.txt b/owl-bot-staging/v2/testing/constraints-3.12.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.12.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.7.txt b/owl-bot-staging/v2/testing/constraints-3.7.txt deleted file mode 100644 index 6c44adf..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.7.txt +++ /dev/null @@ -1,9 +0,0 @@ -# This constraints file is used to check that lower bounds -# are correct in setup.py -# List all library dependencies and extras in this file. -# Pin the version to the lower bound. -# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.0 -proto-plus==1.22.0 -protobuf==3.19.5 diff --git a/owl-bot-staging/v2/testing/constraints-3.8.txt b/owl-bot-staging/v2/testing/constraints-3.8.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.8.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.9.txt b/owl-bot-staging/v2/testing/constraints-3.9.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.9.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v2/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 5058381..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py +++ /dev/null @@ -1,2551 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -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,transport_name", [ - (Controller2Client, "grpc"), - (Controller2AsyncClient, "grpc_asyncio"), - (Controller2Client, "rest"), -]) -def test_controller2_client_from_service_account_info(client_class, transport_name): - 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, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.Controller2GrpcTransport, "grpc"), - (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), - (transports.Controller2RestTransport, "rest"), -]) -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,transport_name", [ - (Controller2Client, "grpc"), - (Controller2AsyncClient, "grpc_asyncio"), - (Controller2Client, "rest"), -]) -def test_controller2_client_from_service_account_file(client_class, transport_name): - 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", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -def test_controller2_client_get_transport_class(): - transport = Controller2Client.get_transport_class() - available_transports = [ - transports.Controller2GrpcTransport, - transports.Controller2RestTransport, - ] - 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"), - (Controller2Client, transports.Controller2RestTransport, "rest"), -]) -@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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - 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=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@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"), - (Controller2Client, transports.Controller2RestTransport, "rest", "true"), - (Controller2Client, transports.Controller2RestTransport, "rest", "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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - -@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"), - (Controller2Client, transports.Controller2RestTransport, "rest"), -]) -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, - api_audience=None, - ) - -@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), - (Controller2Client, transports.Controller2RestTransport, "rest", None), -]) -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, - api_audience=None, - ) - -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, - api_audience=None, - ) - - -@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, - api_audience=None, - ) - - # 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_field_headers(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.ListActiveBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # 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: - call.return_value = controller.ListActiveBreakpointsResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_active_breakpoints_field_headers_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.ListActiveBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # 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: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.UpdateActiveBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint.id = 'id_value' - - # 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: - call.return_value = controller.UpdateActiveBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_active_breakpoint_field_headers_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.UpdateActiveBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint.id = 'id_value' - - # 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: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', - ) in kw['metadata'] - - -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'), - ) - - -@pytest.mark.parametrize("request_type", [ - controller.RegisterDebuggeeRequest, - dict, -]) -def test_register_debuggee_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.register_debuggee(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.RegisterDebuggeeResponse) - - -def test_register_debuggee_rest_required_fields(request_type=controller.RegisterDebuggeeRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.register_debuggee(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_register_debuggee_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.register_debuggee._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("debuggee", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_register_debuggee_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_register_debuggee") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_register_debuggee") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.RegisterDebuggeeRequest.pb(controller.RegisterDebuggeeRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.RegisterDebuggeeResponse.to_json(controller.RegisterDebuggeeResponse()) - - request = controller.RegisterDebuggeeRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.RegisterDebuggeeResponse() - - client.register_debuggee(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_register_debuggee_rest_bad_request(transport: str = 'rest', request_type=controller.RegisterDebuggeeRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.register_debuggee(request) - - -def test_register_debuggee_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {} - - # get truthy value for each flattened field - mock_args = dict( - debuggee=data.Debuggee(id='id_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.register_debuggee(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/register" % client.transport._host, args[1]) - - -def test_register_debuggee_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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'), - ) - - -def test_register_debuggee_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - controller.ListActiveBreakpointsRequest, - dict, -]) -def test_list_active_breakpoints_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse( - next_wait_token='next_wait_token_value', - wait_expired=True, - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_active_breakpoints(request) - - # 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_rest_required_fields(request_type=controller.ListActiveBreakpointsRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("success_on_timeout", "wait_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_active_breakpoints(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_active_breakpoints_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_active_breakpoints._get_unset_required_fields({}) - assert set(unset_fields) == (set(("successOnTimeout", "waitToken", )) & set(("debuggeeId", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_active_breakpoints_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_list_active_breakpoints") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_list_active_breakpoints") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.ListActiveBreakpointsRequest.pb(controller.ListActiveBreakpointsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.ListActiveBreakpointsResponse.to_json(controller.ListActiveBreakpointsResponse()) - - request = controller.ListActiveBreakpointsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.ListActiveBreakpointsResponse() - - client.list_active_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_active_breakpoints_rest_bad_request(transport: str = 'rest', request_type=controller.ListActiveBreakpointsRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_active_breakpoints(request) - - -def test_list_active_breakpoints_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_active_breakpoints(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) - - -def test_list_active_breakpoints_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_active_breakpoints_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - controller.UpdateActiveBreakpointRequest, - dict, -]) -def test_update_active_breakpoint_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.update_active_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.UpdateActiveBreakpointResponse) - - -def test_update_active_breakpoint_rest_required_fields(request_type=controller.UpdateActiveBreakpointRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "put", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.update_active_breakpoint(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_update_active_breakpoint_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.update_active_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("debuggeeId", "breakpoint", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_active_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_update_active_breakpoint") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_update_active_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.UpdateActiveBreakpointRequest.pb(controller.UpdateActiveBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.UpdateActiveBreakpointResponse.to_json(controller.UpdateActiveBreakpointResponse()) - - request = controller.UpdateActiveBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.UpdateActiveBreakpointResponse() - - client.update_active_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_update_active_breakpoint_rest_bad_request(transport: str = 'rest', request_type=controller.UpdateActiveBreakpointRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.update_active_breakpoint(request) - - -def test_update_active_breakpoint_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.update_active_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}" % client.transport._host, args[1]) - - -def test_update_active_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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'), - ) - - -def test_update_active_breakpoint_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -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, - transports.Controller2RestTransport, -]) -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() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = Controller2Client.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -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() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -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", - [ - transports.Controller2GrpcTransport, - transports.Controller2GrpcAsyncIOTransport, - transports.Controller2RestTransport, - ], -) -def test_controller2_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@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_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.Controller2RestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_controller2_host_no_port(transport_name): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_controller2_host_with_port(transport_name): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_controller2_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = Controller2Client( - credentials=creds1, - transport=transport_name, - ) - client2 = Controller2Client( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.register_debuggee._session - session2 = client2.transport.register_debuggee._session - assert session1 != session2 - session1 = client1.transport.list_active_breakpoints._session - session2 = client2.transport.list_active_breakpoints._session - assert session1 != session2 - session1 = client1.transport.update_active_breakpoint._session - session2 = client2.transport.update_active_breakpoint._session - assert session1 != session2 -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 = { - "rest": "_session", - "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 = [ - 'rest', - '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, - api_audience=None, - ) 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 ad07b63..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py +++ /dev/null @@ -1,3628 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -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,transport_name", [ - (Debugger2Client, "grpc"), - (Debugger2AsyncClient, "grpc_asyncio"), - (Debugger2Client, "rest"), -]) -def test_debugger2_client_from_service_account_info(client_class, transport_name): - 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, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.Debugger2GrpcTransport, "grpc"), - (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), - (transports.Debugger2RestTransport, "rest"), -]) -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,transport_name", [ - (Debugger2Client, "grpc"), - (Debugger2AsyncClient, "grpc_asyncio"), - (Debugger2Client, "rest"), -]) -def test_debugger2_client_from_service_account_file(client_class, transport_name): - 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", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -def test_debugger2_client_get_transport_class(): - transport = Debugger2Client.get_transport_class() - available_transports = [ - transports.Debugger2GrpcTransport, - transports.Debugger2RestTransport, - ] - 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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest"), -]) -@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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - 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=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest", "true"), - (Debugger2Client, transports.Debugger2RestTransport, "rest", "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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - -@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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest"), -]) -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, - api_audience=None, - ) - -@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), - (Debugger2Client, transports.Debugger2RestTransport, "rest", None), -]) -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, - api_audience=None, - ) - -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, - api_audience=None, - ) - - -@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, - api_audience=None, - ) - - # 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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.SetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - call.return_value = debugger.SetBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_set_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.SetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.GetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - call.return_value = debugger.GetBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.GetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.DeleteBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - call.return_value = None - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.DeleteBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.ListBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - call.return_value = debugger.ListBreakpointsResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_breakpoints_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.ListBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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', - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.SetBreakpointRequest, - dict, -]) -def test_set_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.set_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.SetBreakpointResponse) - - -def test_set_breakpoint_rest_required_fields(request_type=debugger.SetBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("breakpoint_", "client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.set_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_set_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.set_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("breakpoint", "clientVersion", )) & set(("debuggeeId", "breakpoint", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_set_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_set_breakpoint") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_set_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.SetBreakpointRequest.pb(debugger.SetBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.SetBreakpointResponse.to_json(debugger.SetBreakpointResponse()) - - request = debugger.SetBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.SetBreakpointResponse() - - client.set_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_set_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.SetBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.set_breakpoint(request) - - -def test_set_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.set_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/set" % client.transport._host, args[1]) - - -def test_set_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_set_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.GetBreakpointRequest, - dict, -]) -def test_get_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.get_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.GetBreakpointResponse) - - -def test_get_breakpoint_rest_required_fields(request_type=debugger.GetBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["breakpoint_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["breakpointId"] = 'breakpoint_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "breakpointId" in jsonified_request - assert jsonified_request["breakpointId"] == 'breakpoint_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.get_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_get_breakpoint") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_get_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.GetBreakpointRequest.pb(debugger.GetBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.GetBreakpointResponse.to_json(debugger.GetBreakpointResponse()) - - request = debugger.GetBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.GetBreakpointResponse() - - client.get_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.GetBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.get_breakpoint(request) - - -def test_get_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.get_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) - - -def test_get_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_get_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.DeleteBreakpointRequest, - dict, -]) -def test_delete_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.delete_breakpoint(request) - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_breakpoint_rest_required_fields(request_type=debugger.DeleteBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["breakpoint_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["breakpointId"] = 'breakpoint_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "breakpointId" in jsonified_request - assert jsonified_request["breakpointId"] == 'breakpoint_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = None - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "delete", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.delete_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_delete_breakpoint") as pre: - pre.assert_not_called() - pb_message = debugger.DeleteBreakpointRequest.pb(debugger.DeleteBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - - request = debugger.DeleteBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.delete_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_delete_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.DeleteBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.delete_breakpoint(request) - - -def test_delete_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.delete_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) - - -def test_delete_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_delete_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.ListBreakpointsRequest, - dict, -]) -def test_list_breakpoints_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse( - next_wait_token='next_wait_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_breakpoints(request) - - # 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_rest_required_fields(request_type=debugger.ListBreakpointsRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("action", "client_version", "include_all_users", "include_inactive", "strip_results", "wait_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_breakpoints(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_breakpoints_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_breakpoints._get_unset_required_fields({}) - assert set(unset_fields) == (set(("action", "clientVersion", "includeAllUsers", "includeInactive", "stripResults", "waitToken", )) & set(("debuggeeId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_breakpoints_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_list_breakpoints") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_breakpoints") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.ListBreakpointsRequest.pb(debugger.ListBreakpointsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.ListBreakpointsResponse.to_json(debugger.ListBreakpointsResponse()) - - request = debugger.ListBreakpointsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.ListBreakpointsResponse() - - client.list_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_breakpoints_rest_bad_request(transport: str = 'rest', request_type=debugger.ListBreakpointsRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_breakpoints(request) - - -def test_list_breakpoints_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_breakpoints(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) - - -def test_list_breakpoints_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_breakpoints_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.ListDebuggeesRequest, - dict, -]) -def test_list_debuggees_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_debuggees(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.ListDebuggeesResponse) - - -def test_list_debuggees_rest_required_fields(request_type=debugger.ListDebuggeesRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["project"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "project" not in jsonified_request - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "project" in jsonified_request - assert jsonified_request["project"] == request_init["project"] - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["project"] = 'project_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", "include_inactive", "project", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "project" in jsonified_request - assert jsonified_request["project"] == 'project_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_debuggees(request) - - expected_params = [ - ( - "project", - "", - ), - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_debuggees_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_debuggees._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", "includeInactive", "project", )) & set(("project", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_debuggees_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_list_debuggees") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_debuggees") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.ListDebuggeesRequest.pb(debugger.ListDebuggeesRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.ListDebuggeesResponse.to_json(debugger.ListDebuggeesResponse()) - - request = debugger.ListDebuggeesRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.ListDebuggeesResponse() - - client.list_debuggees(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_debuggees_rest_bad_request(transport: str = 'rest', request_type=debugger.ListDebuggeesRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_debuggees(request) - - -def test_list_debuggees_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {} - - # get truthy value for each flattened field - mock_args = dict( - project='project_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_debuggees(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees" % client.transport._host, args[1]) - - -def test_list_debuggees_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_debuggees_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -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, - transports.Debugger2RestTransport, -]) -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() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = Debugger2Client.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -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() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -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", - [ - transports.Debugger2GrpcTransport, - transports.Debugger2GrpcAsyncIOTransport, - transports.Debugger2RestTransport, - ], -) -def test_debugger2_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@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_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.Debugger2RestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_debugger2_host_no_port(transport_name): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_debugger2_host_with_port(transport_name): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_debugger2_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = Debugger2Client( - credentials=creds1, - transport=transport_name, - ) - client2 = Debugger2Client( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.set_breakpoint._session - session2 = client2.transport.set_breakpoint._session - assert session1 != session2 - session1 = client1.transport.get_breakpoint._session - session2 = client2.transport.get_breakpoint._session - assert session1 != session2 - session1 = client1.transport.delete_breakpoint._session - session2 = client2.transport.delete_breakpoint._session - assert session1 != session2 - session1 = client1.transport.list_breakpoints._session - session2 = client2.transport.list_breakpoints._session - assert session1 != session2 - session1 = client1.transport.list_debuggees._session - session2 = client2.transport.list_debuggees._session - assert session1 != session2 -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 = { - "rest": "_session", - "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 = [ - 'rest', - '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, - api_audience=None, - ) From 221939f719cdbf6fd932efbfa9b1329501b489f6 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Tue, 4 Jul 2023 17:36:18 +0000 Subject: [PATCH 07/10] fix: Add async context manager return types chore: Mock return_value should not populate oneof message fields chore: Support snippet generation for services that only support REST transport chore: Update gapic-generator-python to v1.11.0 PiperOrigin-RevId: 545430278 Source-Link: https://github.com/googleapis/googleapis/commit/601b5326107eeb74800b426d1f9933faa233258a Source-Link: https://github.com/googleapis/googleapis-gen/commit/b3f18d0f6560a855022fd058865e7620479d7af9 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYjNmMThkMGY2NTYwYTg1NTAyMmZkMDU4ODY1ZTc2MjA0NzlkN2FmOSJ9 --- owl-bot-staging/v2/.coveragerc | 13 + owl-bot-staging/v2/.flake8 | 33 + 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 | 6 + owl-bot-staging/v2/docs/index.rst | 7 + .../v2/google/cloud/debugger/__init__.py | 75 + .../v2/google/cloud/debugger/gapic_version.py | 16 + .../v2/google/cloud/debugger/py.typed | 2 + .../v2/google/cloud/debugger_v2/__init__.py | 76 + .../cloud/debugger_v2/gapic_metadata.json | 167 + .../google/cloud/debugger_v2/gapic_version.py | 16 + .../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 | 566 +++ .../services/controller2/client.py | 747 ++++ .../controller2/transports/__init__.py | 38 + .../services/controller2/transports/base.py | 191 + .../services/controller2/transports/grpc.py | 369 ++ .../controller2/transports/grpc_asyncio.py | 368 ++ .../services/controller2/transports/rest.py | 553 +++ .../services/debugger2/__init__.py | 22 + .../services/debugger2/async_client.py | 806 ++++ .../debugger_v2/services/debugger2/client.py | 973 +++++ .../services/debugger2/transports/__init__.py | 38 + .../services/debugger2/transports/base.py | 234 ++ .../services/debugger2/transports/grpc.py | 381 ++ .../debugger2/transports/grpc_asyncio.py | 380 ++ .../services/debugger2/transports/rest.py | 729 ++++ .../cloud/debugger_v2/types/__init__.py | 68 + .../cloud/debugger_v2/types/controller.py | 176 + .../v2/google/cloud/debugger_v2/types/data.py | 681 ++++ .../cloud/debugger_v2/types/debugger.py | 315 ++ owl-bot-staging/v2/mypy.ini | 3 + owl-bot-staging/v2/noxfile.py | 184 + ...ntroller2_list_active_breakpoints_async.py | 52 + ...ontroller2_list_active_breakpoints_sync.py | 52 + ...ted_controller2_register_debuggee_async.py | 51 + ...ated_controller2_register_debuggee_sync.py | 51 + ...troller2_update_active_breakpoint_async.py | 52 + ...ntroller2_update_active_breakpoint_sync.py | 52 + ...rated_debugger2_delete_breakpoint_async.py | 52 + ...erated_debugger2_delete_breakpoint_sync.py | 52 + ...enerated_debugger2_get_breakpoint_async.py | 54 + ...generated_debugger2_get_breakpoint_sync.py | 54 + ...erated_debugger2_list_breakpoints_async.py | 53 + ...nerated_debugger2_list_breakpoints_sync.py | 53 + ...enerated_debugger2_list_debuggees_async.py | 53 + ...generated_debugger2_list_debuggees_sync.py | 53 + ...enerated_debugger2_set_breakpoint_async.py | 53 + ...generated_debugger2_set_breakpoint_sync.py | 53 + ...data_google.devtools.clouddebugger.v2.json | 1369 +++++++ .../v2/scripts/fixup_debugger_v2_keywords.py | 183 + owl-bot-staging/v2/setup.py | 90 + .../v2/testing/constraints-3.10.txt | 6 + .../v2/testing/constraints-3.11.txt | 6 + .../v2/testing/constraints-3.12.txt | 6 + .../v2/testing/constraints-3.7.txt | 9 + .../v2/testing/constraints-3.8.txt | 6 + .../v2/testing/constraints-3.9.txt | 6 + 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 | 2551 ++++++++++++ .../unit/gapic/debugger_v2/test_debugger2.py | 3628 +++++++++++++++++ 71 files changed, 17482 insertions(+) create mode 100644 owl-bot-staging/v2/.coveragerc create mode 100644 owl-bot-staging/v2/.flake8 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/gapic_version.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/gapic_version.py 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/controller2/transports/rest.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/services/debugger2/transports/rest.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/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json 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/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.9.txt 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..9620812 --- /dev/null +++ b/owl-bot-staging/v2/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/debugger/__init__.py + google/cloud/debugger/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v2/.flake8 b/owl-bot-staging/v2/.flake8 new file mode 100644 index 0000000..29227d4 --- /dev/null +++ b/owl-bot-staging/v2/.flake8 @@ -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 +# +# https://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. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py 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..4ad5ea1 --- /dev/null +++ b/owl-bot-staging/v2/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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"2022, 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..0106467 --- /dev/null +++ b/owl-bot-staging/v2/docs/debugger_v2/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Debugger v2 API +====================================== + +.. automodule:: google.cloud.debugger_v2.types + :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..1228468 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger/__init__.py @@ -0,0 +1,75 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 import gapic_version as package_version + +__version__ = package_version.__version__ + + +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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py new file mode 100644 index 0000000..30274cc --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +__version__ = "0.0.0" # {x-release-please-version} 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..c774017 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 import gapic_version as package_version + +__version__ = package_version.__version__ + + +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..f0d8a90 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json @@ -0,0 +1,167 @@ + { + "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" + ] + } + } + }, + "rest": { + "libraryClient": "Controller2Client", + "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" + ] + } + } + }, + "rest": { + "libraryClient": "Debugger2Client", + "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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py new file mode 100644 index 0000000..30274cc --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +__version__ = "0.0.0" # {x-release-please-version} 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..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..e010a73 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..e81f163 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py @@ -0,0 +1,566 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 variable 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: Optional[ga_credentials.Credentials] = None, + transport: Union[str, Controller2Transport] = "grpc_asyncio", + client_options: Optional[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: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, + *, + debuggee: Optional[data.Debuggee] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = await client.register_debuggee(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint.id", request.breakpoint.id), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self) -> "Controller2AsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..7330718 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py @@ -0,0 +1,747 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 +from .transports.rest import Controller2RestTransport + + +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 + _transport_registry["rest"] = Controller2RestTransport + + def get_transport_class(cls, + label: Optional[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 variable 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: Optional[Union[str, Controller2Transport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() + client_options = cast(client_options_lib.ClientOptions, client_options) + + 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, + api_audience=client_options.api_audience, + ) + + def register_debuggee(self, + request: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, + *, + debuggee: Optional[data.Debuggee] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = client.register_debuggee(request=request) + + # Handle the response + print(response) + + 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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_active_breakpoint(self, + request: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint.id", request.breakpoint.id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "Controller2Client": + 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() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..0381ff4 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +from .rest import Controller2RestTransport +from .rest import Controller2RestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] +_transport_registry['grpc'] = Controller2GrpcTransport +_transport_registry['grpc_asyncio'] = Controller2GrpcAsyncIOTransport +_transport_registry['rest'] = Controller2RestTransport + +__all__ = ( + 'Controller2Transport', + 'Controller2GrpcTransport', + 'Controller2GrpcAsyncIOTransport', + 'Controller2RestTransport', + 'Controller2RestInterceptor', +) 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..8e480a6 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py @@ -0,0 +1,191 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +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: Optional[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, + api_audience: Optional[str] = None, + **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. + """ + + 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) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # 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 + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + 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() + + @property + def kind(self) -> str: + 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..09e2efa --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py @@ -0,0 +1,369 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[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() + + @property + def kind(self) -> str: + return "grpc" + + +__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..ae65db1 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py @@ -0,0 +1,368 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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/controller2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py new file mode 100644 index 0000000..e172241 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py @@ -0,0 +1,553 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +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 .base import Controller2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class Controller2RestInterceptor: + """Interceptor for Controller2. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the Controller2RestTransport. + + .. code-block:: python + class MyCustomController2Interceptor(Controller2RestInterceptor): + def pre_list_active_breakpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_active_breakpoints(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_register_debuggee(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_register_debuggee(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_active_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_active_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + transport = Controller2RestTransport(interceptor=MyCustomController2Interceptor()) + client = Controller2Client(transport=transport) + + + """ + def pre_list_active_breakpoints(self, request: controller.ListActiveBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.ListActiveBreakpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_active_breakpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_list_active_breakpoints(self, response: controller.ListActiveBreakpointsResponse) -> controller.ListActiveBreakpointsResponse: + """Post-rpc interceptor for list_active_breakpoints + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + def pre_register_debuggee(self, request: controller.RegisterDebuggeeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.RegisterDebuggeeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for register_debuggee + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_register_debuggee(self, response: controller.RegisterDebuggeeResponse) -> controller.RegisterDebuggeeResponse: + """Post-rpc interceptor for register_debuggee + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + def pre_update_active_breakpoint(self, request: controller.UpdateActiveBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.UpdateActiveBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_active_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_update_active_breakpoint(self, response: controller.UpdateActiveBreakpointResponse) -> controller.UpdateActiveBreakpointResponse: + """Post-rpc interceptor for update_active_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class Controller2RestStub: + _session: AuthorizedSession + _host: str + _interceptor: Controller2RestInterceptor + + +class Controller2RestTransport(Controller2Transport): + """REST 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 JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[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, + url_scheme: str = 'https', + interceptor: Optional[Controller2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> 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 ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` 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 are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or Controller2RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _ListActiveBreakpoints(Controller2RestStub): + def __hash__(self): + return hash("ListActiveBreakpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.ListActiveBreakpointsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.ListActiveBreakpointsResponse: + r"""Call the list active breakpoints method over HTTP. + + Args: + request (~.controller.ListActiveBreakpointsRequest): + The request object. Request to list active breakpoints. + 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: + ~.controller.ListActiveBreakpointsResponse: + Response for listing active + breakpoints. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints', + }, + ] + request, metadata = self._interceptor.pre_list_active_breakpoints(request, metadata) + pb_request = controller.ListActiveBreakpointsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.ListActiveBreakpointsResponse() + pb_resp = controller.ListActiveBreakpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_active_breakpoints(resp) + return resp + + class _RegisterDebuggee(Controller2RestStub): + def __hash__(self): + return hash("RegisterDebuggee") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.RegisterDebuggeeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.RegisterDebuggeeResponse: + r"""Call the register debuggee method over HTTP. + + Args: + request (~.controller.RegisterDebuggeeRequest): + The request object. Request to register a debuggee. + 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: + ~.controller.RegisterDebuggeeResponse: + Response for registering a debuggee. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/controller/debuggees/register', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_register_debuggee(request, metadata) + pb_request = controller.RegisterDebuggeeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.RegisterDebuggeeResponse() + pb_resp = controller.RegisterDebuggeeResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_register_debuggee(resp) + return resp + + class _UpdateActiveBreakpoint(Controller2RestStub): + def __hash__(self): + return hash("UpdateActiveBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.UpdateActiveBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.UpdateActiveBreakpointResponse: + r"""Call the update active breakpoint method over HTTP. + + Args: + request (~.controller.UpdateActiveBreakpointRequest): + The request object. Request to update an active + breakpoint. + 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: + ~.controller.UpdateActiveBreakpointResponse: + Response for updating an active + breakpoint. The message is defined to + allow future extensions. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'put', + 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_update_active_breakpoint(request, metadata) + pb_request = controller.UpdateActiveBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.UpdateActiveBreakpointResponse() + pb_resp = controller.UpdateActiveBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_active_breakpoint(resp) + return resp + + @property + def list_active_breakpoints(self) -> Callable[ + [controller.ListActiveBreakpointsRequest], + controller.ListActiveBreakpointsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListActiveBreakpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def register_debuggee(self) -> Callable[ + [controller.RegisterDebuggeeRequest], + controller.RegisterDebuggeeResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RegisterDebuggee(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_active_breakpoint(self) -> Callable[ + [controller.UpdateActiveBreakpointRequest], + controller.UpdateActiveBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateActiveBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'Controller2RestTransport', +) 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..5d7f609 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..07420ee --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py @@ -0,0 +1,806 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 variable 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: Optional[ga_credentials.Credentials] = None, + transport: Union[str, Debugger2Transport] = "grpc_asyncio", + client_options: Optional[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: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Sets the breakpoint to the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.set_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Gets breakpoint information. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.get_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # 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: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the breakpoint from the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + await client.delete_breakpoint(request=request) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def list_breakpoints(self, + request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Lists all breakpoints for the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_breakpoints(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, + *, + project: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Lists all the debuggees that the user has access to. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_debuggees(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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) -> "Debugger2AsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..7e52f8d --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py @@ -0,0 +1,973 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 +from .transports.rest import Debugger2RestTransport + + +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 + _transport_registry["rest"] = Debugger2RestTransport + + def get_transport_class(cls, + label: Optional[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 variable 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: Optional[Union[str, Debugger2Transport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() + client_options = cast(client_options_lib.ClientOptions, client_options) + + 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, + api_audience=client_options.api_audience, + ) + + def set_breakpoint(self, + request: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Sets the breakpoint to the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.set_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_breakpoint(self, + request: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Gets breakpoint information. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.get_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_breakpoint(self, + request: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the breakpoint from the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + client.delete_breakpoint(request=request) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def list_breakpoints(self, + request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Lists all breakpoints for the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_breakpoints(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_debuggees(self, + request: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, + *, + project: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Lists all the debuggees that the user has access to. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_debuggees(request=request) + + # Handle the response + print(response) + + 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) -> "Debugger2Client": + 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() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..cd9dd46 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +from .rest import Debugger2RestTransport +from .rest import Debugger2RestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] +_transport_registry['grpc'] = Debugger2GrpcTransport +_transport_registry['grpc_asyncio'] = Debugger2GrpcAsyncIOTransport +_transport_registry['rest'] = Debugger2RestTransport + +__all__ = ( + 'Debugger2Transport', + 'Debugger2GrpcTransport', + 'Debugger2GrpcAsyncIOTransport', + 'Debugger2RestTransport', + 'Debugger2RestInterceptor', +) 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..c4afc0c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py @@ -0,0 +1,234 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +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: Optional[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, + api_audience: Optional[str] = None, + **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. + """ + + 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) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # 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 + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + 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() + + @property + def kind(self) -> str: + 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..fbb3374 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py @@ -0,0 +1,381 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[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() + + @property + def kind(self) -> str: + return "grpc" + + +__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..eb6eadc --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py @@ -0,0 +1,380 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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/services/debugger2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py new file mode 100644 index 0000000..63388ac --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py @@ -0,0 +1,729 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +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 debugger +from google.protobuf import empty_pb2 # type: ignore + +from .base import Debugger2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class Debugger2RestInterceptor: + """Interceptor for Debugger2. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the Debugger2RestTransport. + + .. code-block:: python + class MyCustomDebugger2Interceptor(Debugger2RestInterceptor): + def pre_delete_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_breakpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_breakpoints(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_debuggees(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_debuggees(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_set_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_set_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + transport = Debugger2RestTransport(interceptor=MyCustomDebugger2Interceptor()) + client = Debugger2Client(transport=transport) + + + """ + def pre_delete_breakpoint(self, request: debugger.DeleteBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.DeleteBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def pre_get_breakpoint(self, request: debugger.GetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.GetBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_get_breakpoint(self, response: debugger.GetBreakpointResponse) -> debugger.GetBreakpointResponse: + """Post-rpc interceptor for get_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_list_breakpoints(self, request: debugger.ListBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListBreakpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_breakpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_list_breakpoints(self, response: debugger.ListBreakpointsResponse) -> debugger.ListBreakpointsResponse: + """Post-rpc interceptor for list_breakpoints + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_list_debuggees(self, request: debugger.ListDebuggeesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListDebuggeesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_debuggees + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_list_debuggees(self, response: debugger.ListDebuggeesResponse) -> debugger.ListDebuggeesResponse: + """Post-rpc interceptor for list_debuggees + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_set_breakpoint(self, request: debugger.SetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.SetBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for set_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_set_breakpoint(self, response: debugger.SetBreakpointResponse) -> debugger.SetBreakpointResponse: + """Post-rpc interceptor for set_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class Debugger2RestStub: + _session: AuthorizedSession + _host: str + _interceptor: Debugger2RestInterceptor + + +class Debugger2RestTransport(Debugger2Transport): + """REST 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 JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[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, + url_scheme: str = 'https', + interceptor: Optional[Debugger2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> 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 ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` 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 are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or Debugger2RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _DeleteBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("DeleteBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.DeleteBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the delete breakpoint method over HTTP. + + Args: + request (~.debugger.DeleteBreakpointRequest): + The request object. Request to delete a breakpoint. + 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. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', + }, + ] + request, metadata = self._interceptor.pre_delete_breakpoint(request, metadata) + pb_request = debugger.DeleteBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("GetBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.GetBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.GetBreakpointResponse: + r"""Call the get breakpoint method over HTTP. + + Args: + request (~.debugger.GetBreakpointRequest): + The request object. Request to get breakpoint + information. + 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: + ~.debugger.GetBreakpointResponse: + Response for getting breakpoint + information. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', + }, + ] + request, metadata = self._interceptor.pre_get_breakpoint(request, metadata) + pb_request = debugger.GetBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.GetBreakpointResponse() + pb_resp = debugger.GetBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_breakpoint(resp) + return resp + + class _ListBreakpoints(Debugger2RestStub): + def __hash__(self): + return hash("ListBreakpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.ListBreakpointsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.ListBreakpointsResponse: + r"""Call the list breakpoints method over HTTP. + + Args: + request (~.debugger.ListBreakpointsRequest): + The request object. Request to list breakpoints. + 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: + ~.debugger.ListBreakpointsResponse: + Response for listing breakpoints. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints', + }, + ] + request, metadata = self._interceptor.pre_list_breakpoints(request, metadata) + pb_request = debugger.ListBreakpointsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.ListBreakpointsResponse() + pb_resp = debugger.ListBreakpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_breakpoints(resp) + return resp + + class _ListDebuggees(Debugger2RestStub): + def __hash__(self): + return hash("ListDebuggees") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "project" : "", "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.ListDebuggeesRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.ListDebuggeesResponse: + r"""Call the list debuggees method over HTTP. + + Args: + request (~.debugger.ListDebuggeesRequest): + The request object. Request to list debuggees. + 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: + ~.debugger.ListDebuggeesResponse: + Response for listing debuggees. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees', + }, + ] + request, metadata = self._interceptor.pre_list_debuggees(request, metadata) + pb_request = debugger.ListDebuggeesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.ListDebuggeesResponse() + pb_resp = debugger.ListDebuggeesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_debuggees(resp) + return resp + + class _SetBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("SetBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "breakpoint" : {}, "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.SetBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.SetBreakpointResponse: + r"""Call the set breakpoint method over HTTP. + + Args: + request (~.debugger.SetBreakpointRequest): + The request object. Request to set a breakpoint + 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: + ~.debugger.SetBreakpointResponse: + Response for setting a breakpoint. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/set', + 'body': 'breakpoint', + }, + ] + request, metadata = self._interceptor.pre_set_breakpoint(request, metadata) + pb_request = debugger.SetBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.SetBreakpointResponse() + pb_resp = debugger.SetBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_set_breakpoint(resp) + return resp + + @property + def delete_breakpoint(self) -> Callable[ + [debugger.DeleteBreakpointRequest], + empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_breakpoint(self) -> Callable[ + [debugger.GetBreakpointRequest], + debugger.GetBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_breakpoints(self) -> Callable[ + [debugger.ListBreakpointsRequest], + debugger.ListBreakpointsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListBreakpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_debuggees(self) -> Callable[ + [debugger.ListDebuggeesRequest], + debugger.ListDebuggeesResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListDebuggees(self._session, self._host, self._interceptor) # type: ignore + + @property + def set_breakpoint(self) -> Callable[ + [debugger.SetBreakpointRequest], + debugger.SetBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._SetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'Debugger2RestTransport', +) 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..9791b6c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py @@ -0,0 +1,68 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..2ed0286 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py @@ -0,0 +1,176 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +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: data.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: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + wait_token: str = proto.Field( + proto.STRING, + number=2, + ) + success_on_timeout: bool = proto.Field( + proto.BOOL, + number=3, + ) + + +class ListActiveBreakpointsResponse(proto.Message): + r"""Response for listing active breakpoints. + + Attributes: + breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + next_wait_token: str = proto.Field( + proto.STRING, + number=2, + ) + wait_expired: bool = 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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_: data.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..42e4206 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py @@ -0,0 +1,681 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +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 (MutableSequence[str]): + Optional parameters to be embedded into the + message. + """ + + format_: str = proto.Field( + proto.STRING, + number=1, + ) + parameters: MutableSequence[str] = 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. + + Values: + UNSPECIFIED (0): + Status doesn't refer to any particular input. + BREAKPOINT_SOURCE_LOCATION (3): + Status applies to the breakpoint and is + related to its location. + BREAKPOINT_CONDITION (4): + Status applies to the breakpoint and is + related to its condition. + BREAKPOINT_EXPRESSION (7): + Status applies to the breakpoint and is + related to its expressions. + BREAKPOINT_AGE (8): + Status applies to the breakpoint and is + related to its age. + VARIABLE_NAME (5): + Status applies to the entire variable. + VARIABLE_VALUE (6): + Status applies to variable value (variable + name is valid). + """ + UNSPECIFIED = 0 + BREAKPOINT_SOURCE_LOCATION = 3 + BREAKPOINT_CONDITION = 4 + BREAKPOINT_EXPRESSION = 7 + BREAKPOINT_AGE = 8 + VARIABLE_NAME = 5 + VARIABLE_VALUE = 6 + + is_error: bool = proto.Field( + proto.BOOL, + number=1, + ) + refers_to: Reference = proto.Field( + proto.ENUM, + number=2, + enum=Reference, + ) + description: 'FormatMessage' = 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: str = proto.Field( + proto.STRING, + number=1, + ) + line: int = proto.Field( + proto.INT32, + number=2, + ) + column: int = 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 (MutableSequence[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: str = proto.Field( + proto.STRING, + number=1, + ) + value: str = proto.Field( + proto.STRING, + number=2, + ) + type_: str = proto.Field( + proto.STRING, + number=6, + ) + members: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='Variable', + ) + var_table_index: wrappers_pb2.Int32Value = proto.Field( + proto.MESSAGE, + number=4, + message=wrappers_pb2.Int32Value, + ) + status: 'StatusMessage' = 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 (MutableSequence[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_ (MutableSequence[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: str = proto.Field( + proto.STRING, + number=1, + ) + location: 'SourceLocation' = proto.Field( + proto.MESSAGE, + number=2, + message='SourceLocation', + ) + arguments: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='Variable', + ) + locals_: MutableSequence['Variable'] = 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 (MutableSequence[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 (MutableSequence[google.cloud.debugger_v2.types.StackFrame]): + The stack at breakpoint time, where stack_frames[0] + represents the most recently entered function. + evaluated_expressions (MutableSequence[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 (MutableSequence[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 (MutableMapping[str, str]): + 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. + + Values: + CAPTURE (0): + Capture stack frame and variables and update + the breakpoint. The data is only captured once. + After that the breakpoint is set in a final + state. + LOG (1): + Log each breakpoint hit. The breakpoint + remains active until deleted or expired. + """ + CAPTURE = 0 + LOG = 1 + + class LogLevel(proto.Enum): + r"""Log severity levels. + + Values: + INFO (0): + Information log message. + WARNING (1): + Warning log message. + ERROR (2): + Error log message. + """ + INFO = 0 + WARNING = 1 + ERROR = 2 + + id: str = proto.Field( + proto.STRING, + number=1, + ) + action: Action = proto.Field( + proto.ENUM, + number=13, + enum=Action, + ) + location: 'SourceLocation' = proto.Field( + proto.MESSAGE, + number=2, + message='SourceLocation', + ) + condition: str = proto.Field( + proto.STRING, + number=3, + ) + expressions: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=4, + ) + log_message_format: str = proto.Field( + proto.STRING, + number=14, + ) + log_level: LogLevel = proto.Field( + proto.ENUM, + number=15, + enum=LogLevel, + ) + is_final_state: bool = proto.Field( + proto.BOOL, + number=5, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=11, + message=timestamp_pb2.Timestamp, + ) + final_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=12, + message=timestamp_pb2.Timestamp, + ) + user_email: str = proto.Field( + proto.STRING, + number=16, + ) + status: 'StatusMessage' = proto.Field( + proto.MESSAGE, + number=10, + message='StatusMessage', + ) + stack_frames: MutableSequence['StackFrame'] = proto.RepeatedField( + proto.MESSAGE, + number=7, + message='StackFrame', + ) + evaluated_expressions: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=8, + message='Variable', + ) + variable_table: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=9, + message='Variable', + ) + labels: MutableMapping[str, str] = 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 (MutableSequence[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 (MutableSequence[google.devtools.source.v1.source_context_pb2.ExtendedSourceContext]): + References to the locations and revisions of + the source code used in the deployed + application. + labels (MutableMapping[str, str]): + A set of custom debuggee properties, + populated by the agent, to be displayed to the + user. + """ + + id: str = proto.Field( + proto.STRING, + number=1, + ) + project: str = proto.Field( + proto.STRING, + number=2, + ) + uniquifier: str = proto.Field( + proto.STRING, + number=3, + ) + description: str = proto.Field( + proto.STRING, + number=4, + ) + is_inactive: bool = proto.Field( + proto.BOOL, + number=5, + ) + agent_version: str = proto.Field( + proto.STRING, + number=6, + ) + is_disabled: bool = proto.Field( + proto.BOOL, + number=7, + ) + status: 'StatusMessage' = proto.Field( + proto.MESSAGE, + number=8, + message='StatusMessage', + ) + source_contexts: MutableSequence[source_context_pb2.SourceContext] = proto.RepeatedField( + proto.MESSAGE, + number=9, + message=source_context_pb2.SourceContext, + ) + ext_source_contexts: MutableSequence[source_context_pb2.ExtendedSourceContext] = proto.RepeatedField( + proto.MESSAGE, + number=13, + message=source_context_pb2.ExtendedSourceContext, + ) + labels: MutableMapping[str, str] = 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..0c2fa0a --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py @@ -0,0 +1,315 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_: data.Breakpoint = proto.Field( + proto.MESSAGE, + number=2, + message=data.Breakpoint, + ) + client_version: str = 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_: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_id: str = proto.Field( + proto.STRING, + number=2, + ) + client_version: str = 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_: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_id: str = proto.Field( + proto.STRING, + number=2, + ) + client_version: str = 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: data.Breakpoint.Action = proto.Field( + proto.ENUM, + number=1, + enum=data.Breakpoint.Action, + ) + + debuggee_id: str = proto.Field( + proto.STRING, + number=1, + ) + include_all_users: bool = proto.Field( + proto.BOOL, + number=2, + ) + include_inactive: bool = proto.Field( + proto.BOOL, + number=3, + ) + action: BreakpointActionValue = proto.Field( + proto.MESSAGE, + number=4, + message=BreakpointActionValue, + ) + strip_results: bool = proto.Field( + proto.BOOL, + number=5, + ) + wait_token: str = proto.Field( + proto.STRING, + number=6, + ) + client_version: str = proto.Field( + proto.STRING, + number=8, + ) + + +class ListBreakpointsResponse(proto.Message): + r"""Response for listing breakpoints. + + Attributes: + breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + next_wait_token: str = 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: str = proto.Field( + proto.STRING, + number=2, + ) + include_inactive: bool = proto.Field( + proto.BOOL, + number=3, + ) + client_version: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ListDebuggeesResponse(proto.Message): + r"""Response for listing debuggees. + + Attributes: + debuggees (MutableSequence[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: MutableSequence[data.Debuggee] = 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..574c5ae --- /dev/null +++ b/owl-bot-staging/v2/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +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..02ef930 --- /dev/null +++ b/owl-bot-staging/v2/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +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") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/debugger_v2/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +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=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + 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=DEFAULT_PYTHON_VERSION) +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", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py new file mode 100644 index 0000000..24f6ea0 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListActiveBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py new file mode 100644 index 0000000..67c27c7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListActiveBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py new file mode 100644 index 0000000..b0ac801 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDebuggee +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = await client.register_debuggee(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py new file mode 100644 index 0000000..99f6287 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDebuggee +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = client.register_debuggee(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py new file mode 100644 index 0000000..e74e3e7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateActiveBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py new file mode 100644 index 0000000..10a9948 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateActiveBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py new file mode 100644 index 0000000..b445c89 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + await client.delete_breakpoint(request=request) + + +# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py new file mode 100644 index 0000000..01599f2 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + client.delete_breakpoint(request=request) + + +# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py new file mode 100644 index 0000000..7074dcf --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.get_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py new file mode 100644 index 0000000..3f7ebd0 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.get_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py new file mode 100644 index 0000000..816dd2b --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py new file mode 100644 index 0000000..4f65108 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py new file mode 100644 index 0000000..fda422c --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListDebuggees +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_debuggees(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py new file mode 100644 index 0000000..246e83f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListDebuggees +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_debuggees(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py new file mode 100644 index 0000000..6267555 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.set_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py new file mode 100644 index 0000000..22b41d7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.set_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json new file mode 100644 index 0000000..ab6c88f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json @@ -0,0 +1,1369 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.devtools.clouddebugger.v2", + "version": "v2" + } + ], + "language": "PYTHON", + "name": "google-cloud-debugger-client", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.list_active_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "ListActiveBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", + "shortName": "list_active_breakpoints" + }, + "description": "Sample for ListActiveBreakpoints", + "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.list_active_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "ListActiveBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", + "shortName": "list_active_breakpoints" + }, + "description": "Sample for ListActiveBreakpoints", + "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.register_debuggee", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "RegisterDebuggee" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" + }, + { + "name": "debuggee", + "type": "google.cloud.debugger_v2.types.Debuggee" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", + "shortName": "register_debuggee" + }, + "description": "Sample for RegisterDebuggee", + "file": "clouddebugger_v2_generated_controller2_register_debuggee_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_register_debuggee_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.register_debuggee", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "RegisterDebuggee" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" + }, + { + "name": "debuggee", + "type": "google.cloud.debugger_v2.types.Debuggee" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", + "shortName": "register_debuggee" + }, + "description": "Sample for RegisterDebuggee", + "file": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.update_active_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "UpdateActiveBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", + "shortName": "update_active_breakpoint" + }, + "description": "Sample for UpdateActiveBreakpoint", + "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.update_active_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "UpdateActiveBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", + "shortName": "update_active_breakpoint" + }, + "description": "Sample for UpdateActiveBreakpoint", + "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.delete_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "DeleteBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_breakpoint" + }, + "description": "Sample for DeleteBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.delete_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "DeleteBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_breakpoint" + }, + "description": "Sample for DeleteBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.get_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "GetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", + "shortName": "get_breakpoint" + }, + "description": "Sample for GetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_async", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.get_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "GetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", + "shortName": "get_breakpoint" + }, + "description": "Sample for GetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", + "shortName": "list_breakpoints" + }, + "description": "Sample for ListBreakpoints", + "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.list_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", + "shortName": "list_breakpoints" + }, + "description": "Sample for ListBreakpoints", + "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_debuggees", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListDebuggees" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" + }, + { + "name": "project", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", + "shortName": "list_debuggees" + }, + "description": "Sample for ListDebuggees", + "file": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.list_debuggees", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListDebuggees" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" + }, + { + "name": "project", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", + "shortName": "list_debuggees" + }, + "description": "Sample for ListDebuggees", + "file": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.set_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "SetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", + "shortName": "set_breakpoint" + }, + "description": "Sample for SetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.set_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "SetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", + "shortName": "set_breakpoint" + }, + "description": "Sample for SetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py" + } + ] +} 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..9802c14 --- /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 2022 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..4295418 --- /dev/null +++ b/owl-bot-staging/v2/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-debugger-client' + + +description = "Google Cloud Debugger Client API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/debugger/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-debugger-client" + +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() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v2/testing/constraints-3.10.txt b/owl-bot-staging/v2/testing/constraints-3.10.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.11.txt b/owl-bot-staging/v2/testing/constraints-3.11.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.12.txt b/owl-bot-staging/v2/testing/constraints-3.12.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.7.txt b/owl-bot-staging/v2/testing/constraints-3.7.txt new file mode 100644 index 0000000..6c44adf --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v2/testing/constraints-3.8.txt b/owl-bot-staging/v2/testing/constraints-3.8.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.9.txt b/owl-bot-staging/v2/testing/constraints-3.9.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..5058381 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py @@ -0,0 +1,2551 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +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,transport_name", [ + (Controller2Client, "grpc"), + (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), +]) +def test_controller2_client_from_service_account_info(client_class, transport_name): + 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, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.Controller2GrpcTransport, "grpc"), + (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Controller2RestTransport, "rest"), +]) +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,transport_name", [ + (Controller2Client, "grpc"), + (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), +]) +def test_controller2_client_from_service_account_file(client_class, transport_name): + 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", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +def test_controller2_client_get_transport_class(): + transport = Controller2Client.get_transport_class() + available_transports = [ + transports.Controller2GrpcTransport, + transports.Controller2RestTransport, + ] + 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"), + (Controller2Client, transports.Controller2RestTransport, "rest"), +]) +@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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + 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=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@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"), + (Controller2Client, transports.Controller2RestTransport, "rest", "true"), + (Controller2Client, transports.Controller2RestTransport, "rest", "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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + +@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"), + (Controller2Client, transports.Controller2RestTransport, "rest"), +]) +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, + api_audience=None, + ) + +@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), + (Controller2Client, transports.Controller2RestTransport, "rest", None), +]) +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, + api_audience=None, + ) + +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, + api_audience=None, + ) + + +@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, + api_audience=None, + ) + + # 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_field_headers(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.ListActiveBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # 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: + call.return_value = controller.ListActiveBreakpointsResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_active_breakpoints_field_headers_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.ListActiveBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # 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: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.UpdateActiveBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint.id = 'id_value' + + # 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: + call.return_value = controller.UpdateActiveBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_active_breakpoint_field_headers_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.UpdateActiveBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint.id = 'id_value' + + # 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: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', + ) in kw['metadata'] + + +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'), + ) + + +@pytest.mark.parametrize("request_type", [ + controller.RegisterDebuggeeRequest, + dict, +]) +def test_register_debuggee_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.register_debuggee(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.RegisterDebuggeeResponse) + + +def test_register_debuggee_rest_required_fields(request_type=controller.RegisterDebuggeeRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.register_debuggee(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_register_debuggee_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.register_debuggee._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("debuggee", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_register_debuggee_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_register_debuggee") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_register_debuggee") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.RegisterDebuggeeRequest.pb(controller.RegisterDebuggeeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.RegisterDebuggeeResponse.to_json(controller.RegisterDebuggeeResponse()) + + request = controller.RegisterDebuggeeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.RegisterDebuggeeResponse() + + client.register_debuggee(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_register_debuggee_rest_bad_request(transport: str = 'rest', request_type=controller.RegisterDebuggeeRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.register_debuggee(request) + + +def test_register_debuggee_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + debuggee=data.Debuggee(id='id_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.register_debuggee(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/register" % client.transport._host, args[1]) + + +def test_register_debuggee_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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'), + ) + + +def test_register_debuggee_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + controller.ListActiveBreakpointsRequest, + dict, +]) +def test_list_active_breakpoints_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse( + next_wait_token='next_wait_token_value', + wait_expired=True, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_active_breakpoints(request) + + # 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_rest_required_fields(request_type=controller.ListActiveBreakpointsRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("success_on_timeout", "wait_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_active_breakpoints(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_active_breakpoints_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_active_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == (set(("successOnTimeout", "waitToken", )) & set(("debuggeeId", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_active_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_list_active_breakpoints") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_list_active_breakpoints") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.ListActiveBreakpointsRequest.pb(controller.ListActiveBreakpointsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.ListActiveBreakpointsResponse.to_json(controller.ListActiveBreakpointsResponse()) + + request = controller.ListActiveBreakpointsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.ListActiveBreakpointsResponse() + + client.list_active_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_active_breakpoints_rest_bad_request(transport: str = 'rest', request_type=controller.ListActiveBreakpointsRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_active_breakpoints(request) + + +def test_list_active_breakpoints_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_active_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) + + +def test_list_active_breakpoints_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_active_breakpoints_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + controller.UpdateActiveBreakpointRequest, + dict, +]) +def test_update_active_breakpoint_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_active_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.UpdateActiveBreakpointResponse) + + +def test_update_active_breakpoint_rest_required_fields(request_type=controller.UpdateActiveBreakpointRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "put", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_active_breakpoint(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_active_breakpoint_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_active_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("debuggeeId", "breakpoint", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_active_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_update_active_breakpoint") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_update_active_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.UpdateActiveBreakpointRequest.pb(controller.UpdateActiveBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.UpdateActiveBreakpointResponse.to_json(controller.UpdateActiveBreakpointResponse()) + + request = controller.UpdateActiveBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.UpdateActiveBreakpointResponse() + + client.update_active_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_active_breakpoint_rest_bad_request(transport: str = 'rest', request_type=controller.UpdateActiveBreakpointRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_active_breakpoint(request) + + +def test_update_active_breakpoint_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_active_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}" % client.transport._host, args[1]) + + +def test_update_active_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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'), + ) + + +def test_update_active_breakpoint_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +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, + transports.Controller2RestTransport, +]) +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() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = Controller2Client.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +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() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +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", + [ + transports.Controller2GrpcTransport, + transports.Controller2GrpcAsyncIOTransport, + transports.Controller2RestTransport, + ], +) +def test_controller2_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@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_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.Controller2RestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_controller2_host_no_port(transport_name): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_controller2_host_with_port(transport_name): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_controller2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Controller2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Controller2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.register_debuggee._session + session2 = client2.transport.register_debuggee._session + assert session1 != session2 + session1 = client1.transport.list_active_breakpoints._session + session2 = client2.transport.list_active_breakpoints._session + assert session1 != session2 + session1 = client1.transport.update_active_breakpoint._session + session2 = client2.transport.update_active_breakpoint._session + assert session1 != session2 +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 = { + "rest": "_session", + "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 = [ + 'rest', + '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, + api_audience=None, + ) 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..ad07b63 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py @@ -0,0 +1,3628 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +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,transport_name", [ + (Debugger2Client, "grpc"), + (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), +]) +def test_debugger2_client_from_service_account_info(client_class, transport_name): + 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, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.Debugger2GrpcTransport, "grpc"), + (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Debugger2RestTransport, "rest"), +]) +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,transport_name", [ + (Debugger2Client, "grpc"), + (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), +]) +def test_debugger2_client_from_service_account_file(client_class, transport_name): + 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", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +def test_debugger2_client_get_transport_class(): + transport = Debugger2Client.get_transport_class() + available_transports = [ + transports.Debugger2GrpcTransport, + transports.Debugger2RestTransport, + ] + 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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), +]) +@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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + 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=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "true"), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + +@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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), +]) +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, + api_audience=None, + ) + +@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), + (Debugger2Client, transports.Debugger2RestTransport, "rest", None), +]) +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, + api_audience=None, + ) + +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, + api_audience=None, + ) + + +@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, + api_audience=None, + ) + + # 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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.SetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + call.return_value = debugger.SetBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_set_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.SetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.GetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + call.return_value = debugger.GetBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.GetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.DeleteBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + call.return_value = None + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.DeleteBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.ListBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + call.return_value = debugger.ListBreakpointsResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_breakpoints_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.ListBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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', + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.SetBreakpointRequest, + dict, +]) +def test_set_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.set_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.SetBreakpointResponse) + + +def test_set_breakpoint_rest_required_fields(request_type=debugger.SetBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("breakpoint_", "client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.set_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_set_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.set_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("breakpoint", "clientVersion", )) & set(("debuggeeId", "breakpoint", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_set_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_set_breakpoint") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_set_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.SetBreakpointRequest.pb(debugger.SetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.SetBreakpointResponse.to_json(debugger.SetBreakpointResponse()) + + request = debugger.SetBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.SetBreakpointResponse() + + client.set_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_set_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.SetBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.set_breakpoint(request) + + +def test_set_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.set_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/set" % client.transport._host, args[1]) + + +def test_set_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_set_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.GetBreakpointRequest, + dict, +]) +def test_get_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.GetBreakpointResponse) + + +def test_get_breakpoint_rest_required_fields(request_type=debugger.GetBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["breakpointId"] = 'breakpoint_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == 'breakpoint_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_get_breakpoint") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_get_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.GetBreakpointRequest.pb(debugger.GetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.GetBreakpointResponse.to_json(debugger.GetBreakpointResponse()) + + request = debugger.GetBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.GetBreakpointResponse() + + client.get_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.GetBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_breakpoint(request) + + +def test_get_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) + + +def test_get_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_get_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.DeleteBreakpointRequest, + dict, +]) +def test_delete_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_breakpoint(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_breakpoint_rest_required_fields(request_type=debugger.DeleteBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["breakpointId"] = 'breakpoint_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == 'breakpoint_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_delete_breakpoint") as pre: + pre.assert_not_called() + pb_message = debugger.DeleteBreakpointRequest.pb(debugger.DeleteBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = debugger.DeleteBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_delete_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.DeleteBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_breakpoint(request) + + +def test_delete_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) + + +def test_delete_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_delete_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.ListBreakpointsRequest, + dict, +]) +def test_list_breakpoints_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse( + next_wait_token='next_wait_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_breakpoints(request) + + # 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_rest_required_fields(request_type=debugger.ListBreakpointsRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("action", "client_version", "include_all_users", "include_inactive", "strip_results", "wait_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_breakpoints(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_breakpoints_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == (set(("action", "clientVersion", "includeAllUsers", "includeInactive", "stripResults", "waitToken", )) & set(("debuggeeId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_list_breakpoints") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_breakpoints") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListBreakpointsRequest.pb(debugger.ListBreakpointsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListBreakpointsResponse.to_json(debugger.ListBreakpointsResponse()) + + request = debugger.ListBreakpointsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListBreakpointsResponse() + + client.list_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_breakpoints_rest_bad_request(transport: str = 'rest', request_type=debugger.ListBreakpointsRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_breakpoints(request) + + +def test_list_breakpoints_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) + + +def test_list_breakpoints_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_breakpoints_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.ListDebuggeesRequest, + dict, +]) +def test_list_debuggees_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_debuggees(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.ListDebuggeesResponse) + + +def test_list_debuggees_rest_required_fields(request_type=debugger.ListDebuggeesRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["project"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "project" not in jsonified_request + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "project" in jsonified_request + assert jsonified_request["project"] == request_init["project"] + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["project"] = 'project_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", "include_inactive", "project", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "project" in jsonified_request + assert jsonified_request["project"] == 'project_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_debuggees(request) + + expected_params = [ + ( + "project", + "", + ), + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_debuggees_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_debuggees._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", "includeInactive", "project", )) & set(("project", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_debuggees_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_list_debuggees") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_debuggees") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListDebuggeesRequest.pb(debugger.ListDebuggeesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListDebuggeesResponse.to_json(debugger.ListDebuggeesResponse()) + + request = debugger.ListDebuggeesRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListDebuggeesResponse() + + client.list_debuggees(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_debuggees_rest_bad_request(transport: str = 'rest', request_type=debugger.ListDebuggeesRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_debuggees(request) + + +def test_list_debuggees_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + project='project_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_debuggees(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees" % client.transport._host, args[1]) + + +def test_list_debuggees_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_debuggees_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +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, + transports.Debugger2RestTransport, +]) +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() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = Debugger2Client.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +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() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +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", + [ + transports.Debugger2GrpcTransport, + transports.Debugger2GrpcAsyncIOTransport, + transports.Debugger2RestTransport, + ], +) +def test_debugger2_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@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_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.Debugger2RestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_debugger2_host_no_port(transport_name): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_debugger2_host_with_port(transport_name): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_debugger2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Debugger2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Debugger2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.set_breakpoint._session + session2 = client2.transport.set_breakpoint._session + assert session1 != session2 + session1 = client1.transport.get_breakpoint._session + session2 = client2.transport.get_breakpoint._session + assert session1 != session2 + session1 = client1.transport.delete_breakpoint._session + session2 = client2.transport.delete_breakpoint._session + assert session1 != session2 + session1 = client1.transport.list_breakpoints._session + session2 = client2.transport.list_breakpoints._session + assert session1 != session2 + session1 = client1.transport.list_debuggees._session + session2 = client2.transport.list_debuggees._session + assert session1 != session2 +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 = { + "rest": "_session", + "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 = [ + 'rest', + '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, + api_audience=None, + ) From f7e878b0529cdd2cda4981b12e513dbd334e1c1e Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Tue, 4 Jul 2023 17:37:44 +0000 Subject: [PATCH 08/10] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20?= =?UTF-8?q?post-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- .../services/controller2/async_client.py | 2 +- .../services/debugger2/async_client.py | 2 +- owl-bot-staging/v2/.coveragerc | 13 - owl-bot-staging/v2/.flake8 | 33 - 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 | 6 - owl-bot-staging/v2/docs/index.rst | 7 - .../v2/google/cloud/debugger/__init__.py | 75 - .../v2/google/cloud/debugger/gapic_version.py | 16 - .../v2/google/cloud/debugger/py.typed | 2 - .../v2/google/cloud/debugger_v2/__init__.py | 76 - .../cloud/debugger_v2/gapic_metadata.json | 167 - .../google/cloud/debugger_v2/gapic_version.py | 16 - .../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 | 566 --- .../services/controller2/client.py | 747 ---- .../controller2/transports/__init__.py | 38 - .../services/controller2/transports/base.py | 191 - .../services/controller2/transports/grpc.py | 369 -- .../controller2/transports/grpc_asyncio.py | 368 -- .../services/controller2/transports/rest.py | 553 --- .../services/debugger2/__init__.py | 22 - .../services/debugger2/async_client.py | 806 ---- .../debugger_v2/services/debugger2/client.py | 973 ----- .../services/debugger2/transports/__init__.py | 38 - .../services/debugger2/transports/base.py | 234 -- .../services/debugger2/transports/grpc.py | 381 -- .../debugger2/transports/grpc_asyncio.py | 380 -- .../services/debugger2/transports/rest.py | 729 ---- .../cloud/debugger_v2/types/__init__.py | 68 - .../cloud/debugger_v2/types/controller.py | 176 - .../v2/google/cloud/debugger_v2/types/data.py | 681 ---- .../cloud/debugger_v2/types/debugger.py | 315 -- owl-bot-staging/v2/mypy.ini | 3 - owl-bot-staging/v2/noxfile.py | 184 - ...ntroller2_list_active_breakpoints_async.py | 52 - ...ontroller2_list_active_breakpoints_sync.py | 52 - ...ted_controller2_register_debuggee_async.py | 51 - ...ated_controller2_register_debuggee_sync.py | 51 - ...troller2_update_active_breakpoint_async.py | 52 - ...ntroller2_update_active_breakpoint_sync.py | 52 - ...rated_debugger2_delete_breakpoint_async.py | 52 - ...erated_debugger2_delete_breakpoint_sync.py | 52 - ...enerated_debugger2_get_breakpoint_async.py | 54 - ...generated_debugger2_get_breakpoint_sync.py | 54 - ...erated_debugger2_list_breakpoints_async.py | 53 - ...nerated_debugger2_list_breakpoints_sync.py | 53 - ...enerated_debugger2_list_debuggees_async.py | 53 - ...generated_debugger2_list_debuggees_sync.py | 53 - ...enerated_debugger2_set_breakpoint_async.py | 53 - ...generated_debugger2_set_breakpoint_sync.py | 53 - ...data_google.devtools.clouddebugger.v2.json | 1369 ------- .../v2/scripts/fixup_debugger_v2_keywords.py | 183 - owl-bot-staging/v2/setup.py | 90 - .../v2/testing/constraints-3.10.txt | 6 - .../v2/testing/constraints-3.11.txt | 6 - .../v2/testing/constraints-3.12.txt | 6 - .../v2/testing/constraints-3.7.txt | 9 - .../v2/testing/constraints-3.8.txt | 6 - .../v2/testing/constraints-3.9.txt | 6 - 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 | 2551 ------------ .../unit/gapic/debugger_v2/test_debugger2.py | 3628 ----------------- 73 files changed, 2 insertions(+), 17484 deletions(-) delete mode 100644 owl-bot-staging/v2/.coveragerc delete mode 100644 owl-bot-staging/v2/.flake8 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/gapic_version.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/gapic_version.py 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/controller2/transports/rest.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/services/debugger2/transports/rest.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/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json 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/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.9.txt 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 ded2c03..c73834c 100644 --- a/google/cloud/debugger_v2/services/controller2/async_client.py +++ b/google/cloud/debugger_v2/services/controller2/async_client.py @@ -594,7 +594,7 @@ async def sample_update_active_breakpoint(): # Done; return the response. return response - async def __aenter__(self): + async def __aenter__(self) -> "Controller2AsyncClient": return self async def __aexit__(self, exc_type, exc, tb): diff --git a/google/cloud/debugger_v2/services/debugger2/async_client.py b/google/cloud/debugger_v2/services/debugger2/async_client.py index 0288d5e..ab1ce7c 100644 --- a/google/cloud/debugger_v2/services/debugger2/async_client.py +++ b/google/cloud/debugger_v2/services/debugger2/async_client.py @@ -846,7 +846,7 @@ async def sample_list_debuggees(): # Done; return the response. return response - async def __aenter__(self): + async def __aenter__(self) -> "Debugger2AsyncClient": return self async def __aexit__(self, exc_type, exc, tb): diff --git a/owl-bot-staging/v2/.coveragerc b/owl-bot-staging/v2/.coveragerc deleted file mode 100644 index 9620812..0000000 --- a/owl-bot-staging/v2/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/debugger/__init__.py - google/cloud/debugger/gapic_version.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ diff --git a/owl-bot-staging/v2/.flake8 b/owl-bot-staging/v2/.flake8 deleted file mode 100644 index 29227d4..0000000 --- a/owl-bot-staging/v2/.flake8 +++ /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 -# -# https://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. - -# Generated by synthtool. DO NOT EDIT! -[flake8] -ignore = E203, E266, E501, W503 -exclude = - # Exclude generated code. - **/proto/** - **/gapic/** - **/services/** - **/types/** - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py 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 4ad5ea1..0000000 --- a/owl-bot-staging/v2/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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"2022, 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 0106467..0000000 --- a/owl-bot-staging/v2/docs/debugger_v2/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Debugger v2 API -====================================== - -.. automodule:: google.cloud.debugger_v2.types - :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 1228468..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger/__init__.py +++ /dev/null @@ -1,75 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 import gapic_version as package_version - -__version__ = package_version.__version__ - - -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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py deleted file mode 100644 index 30274cc..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -__version__ = "0.0.0" # {x-release-please-version} 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 c774017..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py +++ /dev/null @@ -1,76 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 import gapic_version as package_version - -__version__ = package_version.__version__ - - -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 f0d8a90..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json +++ /dev/null @@ -1,167 +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" - ] - } - } - }, - "rest": { - "libraryClient": "Controller2Client", - "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" - ] - } - } - }, - "rest": { - "libraryClient": "Debugger2Client", - "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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py deleted file mode 100644 index 30274cc..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -__version__ = "0.0.0" # {x-release-please-version} 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 e8e1c38..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 e010a73..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 e81f163..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py +++ /dev/null @@ -1,566 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 variable 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: Optional[ga_credentials.Credentials] = None, - transport: Union[str, Controller2Transport] = "grpc_asyncio", - client_options: Optional[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: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, - *, - debuggee: Optional[data.Debuggee] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = await client.register_debuggee(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint.id", request.breakpoint.id), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self) -> "Controller2AsyncClient": - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 7330718..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py +++ /dev/null @@ -1,747 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 -from .transports.rest import Controller2RestTransport - - -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 - _transport_registry["rest"] = Controller2RestTransport - - def get_transport_class(cls, - label: Optional[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 variable 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: Optional[Union[str, Controller2Transport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() - client_options = cast(client_options_lib.ClientOptions, client_options) - - 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, - api_audience=client_options.api_audience, - ) - - def register_debuggee(self, - request: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, - *, - debuggee: Optional[data.Debuggee] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = client.register_debuggee(request=request) - - # Handle the response - print(response) - - 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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_active_breakpoint(self, - request: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint.id", request.breakpoint.id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "Controller2Client": - 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() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 0381ff4..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -from .rest import Controller2RestTransport -from .rest import Controller2RestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] -_transport_registry['grpc'] = Controller2GrpcTransport -_transport_registry['grpc_asyncio'] = Controller2GrpcAsyncIOTransport -_transport_registry['rest'] = Controller2RestTransport - -__all__ = ( - 'Controller2Transport', - 'Controller2GrpcTransport', - 'Controller2GrpcAsyncIOTransport', - 'Controller2RestTransport', - 'Controller2RestInterceptor', -) 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 8e480a6..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py +++ /dev/null @@ -1,191 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -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: Optional[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, - api_audience: Optional[str] = None, - **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. - """ - - 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) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # 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 - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - 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() - - @property - def kind(self) -> str: - 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 09e2efa..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py +++ /dev/null @@ -1,369 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[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() - - @property - def kind(self) -> str: - return "grpc" - - -__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 ae65db1..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py +++ /dev/null @@ -1,368 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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/controller2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py deleted file mode 100644 index e172241..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py +++ /dev/null @@ -1,553 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -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 .base import Controller2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class Controller2RestInterceptor: - """Interceptor for Controller2. - - Interceptors are used to manipulate requests, request metadata, and responses - in arbitrary ways. - Example use cases include: - * Logging - * Verifying requests according to service or custom semantics - * Stripping extraneous information from responses - - These use cases and more can be enabled by injecting an - instance of a custom subclass when constructing the Controller2RestTransport. - - .. code-block:: python - class MyCustomController2Interceptor(Controller2RestInterceptor): - def pre_list_active_breakpoints(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_active_breakpoints(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_register_debuggee(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_register_debuggee(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_active_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_active_breakpoint(self, response): - logging.log(f"Received response: {response}") - return response - - transport = Controller2RestTransport(interceptor=MyCustomController2Interceptor()) - client = Controller2Client(transport=transport) - - - """ - def pre_list_active_breakpoints(self, request: controller.ListActiveBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.ListActiveBreakpointsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_active_breakpoints - - Override in a subclass to manipulate the request or metadata - before they are sent to the Controller2 server. - """ - return request, metadata - - def post_list_active_breakpoints(self, response: controller.ListActiveBreakpointsResponse) -> controller.ListActiveBreakpointsResponse: - """Post-rpc interceptor for list_active_breakpoints - - Override in a subclass to manipulate the response - after it is returned by the Controller2 server but before - it is returned to user code. - """ - return response - def pre_register_debuggee(self, request: controller.RegisterDebuggeeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.RegisterDebuggeeRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for register_debuggee - - Override in a subclass to manipulate the request or metadata - before they are sent to the Controller2 server. - """ - return request, metadata - - def post_register_debuggee(self, response: controller.RegisterDebuggeeResponse) -> controller.RegisterDebuggeeResponse: - """Post-rpc interceptor for register_debuggee - - Override in a subclass to manipulate the response - after it is returned by the Controller2 server but before - it is returned to user code. - """ - return response - def pre_update_active_breakpoint(self, request: controller.UpdateActiveBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.UpdateActiveBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for update_active_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Controller2 server. - """ - return request, metadata - - def post_update_active_breakpoint(self, response: controller.UpdateActiveBreakpointResponse) -> controller.UpdateActiveBreakpointResponse: - """Post-rpc interceptor for update_active_breakpoint - - Override in a subclass to manipulate the response - after it is returned by the Controller2 server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class Controller2RestStub: - _session: AuthorizedSession - _host: str - _interceptor: Controller2RestInterceptor - - -class Controller2RestTransport(Controller2Transport): - """REST 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 JSON representations of protocol buffers over HTTP/1.1 - - """ - - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[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, - url_scheme: str = 'https', - interceptor: Optional[Controller2RestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> 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 ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` 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 are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or Controller2RestInterceptor() - self._prep_wrapped_messages(client_info) - - class _ListActiveBreakpoints(Controller2RestStub): - def __hash__(self): - return hash("ListActiveBreakpoints") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.ListActiveBreakpointsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.ListActiveBreakpointsResponse: - r"""Call the list active breakpoints method over HTTP. - - Args: - request (~.controller.ListActiveBreakpointsRequest): - The request object. Request to list active breakpoints. - 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: - ~.controller.ListActiveBreakpointsResponse: - Response for listing active - breakpoints. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints', - }, - ] - request, metadata = self._interceptor.pre_list_active_breakpoints(request, metadata) - pb_request = controller.ListActiveBreakpointsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = controller.ListActiveBreakpointsResponse() - pb_resp = controller.ListActiveBreakpointsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_active_breakpoints(resp) - return resp - - class _RegisterDebuggee(Controller2RestStub): - def __hash__(self): - return hash("RegisterDebuggee") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.RegisterDebuggeeRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.RegisterDebuggeeResponse: - r"""Call the register debuggee method over HTTP. - - Args: - request (~.controller.RegisterDebuggeeRequest): - The request object. Request to register a debuggee. - 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: - ~.controller.RegisterDebuggeeResponse: - Response for registering a debuggee. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v2/controller/debuggees/register', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_register_debuggee(request, metadata) - pb_request = controller.RegisterDebuggeeRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = controller.RegisterDebuggeeResponse() - pb_resp = controller.RegisterDebuggeeResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_register_debuggee(resp) - return resp - - class _UpdateActiveBreakpoint(Controller2RestStub): - def __hash__(self): - return hash("UpdateActiveBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.UpdateActiveBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.UpdateActiveBreakpointResponse: - r"""Call the update active breakpoint method over HTTP. - - Args: - request (~.controller.UpdateActiveBreakpointRequest): - The request object. Request to update an active - breakpoint. - 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: - ~.controller.UpdateActiveBreakpointResponse: - Response for updating an active - breakpoint. The message is defined to - allow future extensions. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'put', - 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_update_active_breakpoint(request, metadata) - pb_request = controller.UpdateActiveBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = controller.UpdateActiveBreakpointResponse() - pb_resp = controller.UpdateActiveBreakpointResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_update_active_breakpoint(resp) - return resp - - @property - def list_active_breakpoints(self) -> Callable[ - [controller.ListActiveBreakpointsRequest], - controller.ListActiveBreakpointsResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListActiveBreakpoints(self._session, self._host, self._interceptor) # type: ignore - - @property - def register_debuggee(self) -> Callable[ - [controller.RegisterDebuggeeRequest], - controller.RegisterDebuggeeResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._RegisterDebuggee(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_active_breakpoint(self) -> Callable[ - [controller.UpdateActiveBreakpointRequest], - controller.UpdateActiveBreakpointResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._UpdateActiveBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'Controller2RestTransport', -) 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 5d7f609..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 07420ee..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py +++ /dev/null @@ -1,806 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 variable 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: Optional[ga_credentials.Credentials] = None, - transport: Union[str, Debugger2Transport] = "grpc_asyncio", - client_options: Optional[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: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.SetBreakpointResponse: - r"""Sets the breakpoint to the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.set_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.GetBreakpointResponse: - r"""Gets breakpoint information. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.get_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # 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: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the breakpoint from the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - await client.delete_breakpoint(request=request) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def list_breakpoints(self, - request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListBreakpointsResponse: - r"""Lists all breakpoints for the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_breakpoints(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, - *, - project: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListDebuggeesResponse: - r"""Lists all the debuggees that the user has access to. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_debuggees(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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) -> "Debugger2AsyncClient": - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 7e52f8d..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py +++ /dev/null @@ -1,973 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 -from .transports.rest import Debugger2RestTransport - - -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 - _transport_registry["rest"] = Debugger2RestTransport - - def get_transport_class(cls, - label: Optional[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 variable 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: Optional[Union[str, Debugger2Transport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() - client_options = cast(client_options_lib.ClientOptions, client_options) - - 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, - api_audience=client_options.api_audience, - ) - - def set_breakpoint(self, - request: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.SetBreakpointResponse: - r"""Sets the breakpoint to the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.set_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_breakpoint(self, - request: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.GetBreakpointResponse: - r"""Gets breakpoint information. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.get_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_breakpoint(self, - request: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the breakpoint from the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - client.delete_breakpoint(request=request) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def list_breakpoints(self, - request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListBreakpointsResponse: - r"""Lists all breakpoints for the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_breakpoints(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_debuggees(self, - request: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, - *, - project: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListDebuggeesResponse: - r"""Lists all the debuggees that the user has access to. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_debuggees(request=request) - - # Handle the response - print(response) - - 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) -> "Debugger2Client": - 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() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 cd9dd46..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -from .rest import Debugger2RestTransport -from .rest import Debugger2RestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] -_transport_registry['grpc'] = Debugger2GrpcTransport -_transport_registry['grpc_asyncio'] = Debugger2GrpcAsyncIOTransport -_transport_registry['rest'] = Debugger2RestTransport - -__all__ = ( - 'Debugger2Transport', - 'Debugger2GrpcTransport', - 'Debugger2GrpcAsyncIOTransport', - 'Debugger2RestTransport', - 'Debugger2RestInterceptor', -) 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 c4afc0c..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py +++ /dev/null @@ -1,234 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -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: Optional[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, - api_audience: Optional[str] = None, - **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. - """ - - 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) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # 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 - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - 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() - - @property - def kind(self) -> str: - 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 fbb3374..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py +++ /dev/null @@ -1,381 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[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() - - @property - def kind(self) -> str: - return "grpc" - - -__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 eb6eadc..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py +++ /dev/null @@ -1,380 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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/services/debugger2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py deleted file mode 100644 index 63388ac..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py +++ /dev/null @@ -1,729 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -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 debugger -from google.protobuf import empty_pb2 # type: ignore - -from .base import Debugger2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class Debugger2RestInterceptor: - """Interceptor for Debugger2. - - Interceptors are used to manipulate requests, request metadata, and responses - in arbitrary ways. - Example use cases include: - * Logging - * Verifying requests according to service or custom semantics - * Stripping extraneous information from responses - - These use cases and more can be enabled by injecting an - instance of a custom subclass when constructing the Debugger2RestTransport. - - .. code-block:: python - class MyCustomDebugger2Interceptor(Debugger2RestInterceptor): - def pre_delete_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def pre_get_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_breakpoint(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_breakpoints(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_breakpoints(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_debuggees(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_debuggees(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_set_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_set_breakpoint(self, response): - logging.log(f"Received response: {response}") - return response - - transport = Debugger2RestTransport(interceptor=MyCustomDebugger2Interceptor()) - client = Debugger2Client(transport=transport) - - - """ - def pre_delete_breakpoint(self, request: debugger.DeleteBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.DeleteBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for delete_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def pre_get_breakpoint(self, request: debugger.GetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.GetBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_get_breakpoint(self, response: debugger.GetBreakpointResponse) -> debugger.GetBreakpointResponse: - """Post-rpc interceptor for get_breakpoint - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - def pre_list_breakpoints(self, request: debugger.ListBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListBreakpointsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_breakpoints - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_list_breakpoints(self, response: debugger.ListBreakpointsResponse) -> debugger.ListBreakpointsResponse: - """Post-rpc interceptor for list_breakpoints - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - def pre_list_debuggees(self, request: debugger.ListDebuggeesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListDebuggeesRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_debuggees - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_list_debuggees(self, response: debugger.ListDebuggeesResponse) -> debugger.ListDebuggeesResponse: - """Post-rpc interceptor for list_debuggees - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - def pre_set_breakpoint(self, request: debugger.SetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.SetBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for set_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_set_breakpoint(self, response: debugger.SetBreakpointResponse) -> debugger.SetBreakpointResponse: - """Post-rpc interceptor for set_breakpoint - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class Debugger2RestStub: - _session: AuthorizedSession - _host: str - _interceptor: Debugger2RestInterceptor - - -class Debugger2RestTransport(Debugger2Transport): - """REST 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 JSON representations of protocol buffers over HTTP/1.1 - - """ - - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[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, - url_scheme: str = 'https', - interceptor: Optional[Debugger2RestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> 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 ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` 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 are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or Debugger2RestInterceptor() - self._prep_wrapped_messages(client_info) - - class _DeleteBreakpoint(Debugger2RestStub): - def __hash__(self): - return hash("DeleteBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.DeleteBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ): - r"""Call the delete breakpoint method over HTTP. - - Args: - request (~.debugger.DeleteBreakpointRequest): - The request object. Request to delete a breakpoint. - 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. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', - }, - ] - request, metadata = self._interceptor.pre_delete_breakpoint(request, metadata) - pb_request = debugger.DeleteBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - class _GetBreakpoint(Debugger2RestStub): - def __hash__(self): - return hash("GetBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.GetBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.GetBreakpointResponse: - r"""Call the get breakpoint method over HTTP. - - Args: - request (~.debugger.GetBreakpointRequest): - The request object. Request to get breakpoint - information. - 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: - ~.debugger.GetBreakpointResponse: - Response for getting breakpoint - information. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', - }, - ] - request, metadata = self._interceptor.pre_get_breakpoint(request, metadata) - pb_request = debugger.GetBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.GetBreakpointResponse() - pb_resp = debugger.GetBreakpointResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_breakpoint(resp) - return resp - - class _ListBreakpoints(Debugger2RestStub): - def __hash__(self): - return hash("ListBreakpoints") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.ListBreakpointsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.ListBreakpointsResponse: - r"""Call the list breakpoints method over HTTP. - - Args: - request (~.debugger.ListBreakpointsRequest): - The request object. Request to list breakpoints. - 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: - ~.debugger.ListBreakpointsResponse: - Response for listing breakpoints. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints', - }, - ] - request, metadata = self._interceptor.pre_list_breakpoints(request, metadata) - pb_request = debugger.ListBreakpointsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.ListBreakpointsResponse() - pb_resp = debugger.ListBreakpointsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_breakpoints(resp) - return resp - - class _ListDebuggees(Debugger2RestStub): - def __hash__(self): - return hash("ListDebuggees") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "project" : "", "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.ListDebuggeesRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.ListDebuggeesResponse: - r"""Call the list debuggees method over HTTP. - - Args: - request (~.debugger.ListDebuggeesRequest): - The request object. Request to list debuggees. - 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: - ~.debugger.ListDebuggeesResponse: - Response for listing debuggees. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees', - }, - ] - request, metadata = self._interceptor.pre_list_debuggees(request, metadata) - pb_request = debugger.ListDebuggeesRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.ListDebuggeesResponse() - pb_resp = debugger.ListDebuggeesResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_debuggees(resp) - return resp - - class _SetBreakpoint(Debugger2RestStub): - def __hash__(self): - return hash("SetBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "breakpoint" : {}, "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.SetBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.SetBreakpointResponse: - r"""Call the set breakpoint method over HTTP. - - Args: - request (~.debugger.SetBreakpointRequest): - The request object. Request to set a breakpoint - 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: - ~.debugger.SetBreakpointResponse: - Response for setting a breakpoint. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/set', - 'body': 'breakpoint', - }, - ] - request, metadata = self._interceptor.pre_set_breakpoint(request, metadata) - pb_request = debugger.SetBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.SetBreakpointResponse() - pb_resp = debugger.SetBreakpointResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_set_breakpoint(resp) - return resp - - @property - def delete_breakpoint(self) -> Callable[ - [debugger.DeleteBreakpointRequest], - empty_pb2.Empty]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._DeleteBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_breakpoint(self) -> Callable[ - [debugger.GetBreakpointRequest], - debugger.GetBreakpointResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._GetBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_breakpoints(self) -> Callable[ - [debugger.ListBreakpointsRequest], - debugger.ListBreakpointsResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListBreakpoints(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_debuggees(self) -> Callable[ - [debugger.ListDebuggeesRequest], - debugger.ListDebuggeesResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListDebuggees(self._session, self._host, self._interceptor) # type: ignore - - @property - def set_breakpoint(self) -> Callable[ - [debugger.SetBreakpointRequest], - debugger.SetBreakpointResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._SetBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'Debugger2RestTransport', -) 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 9791b6c..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py +++ /dev/null @@ -1,68 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 2ed0286..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py +++ /dev/null @@ -1,176 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -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: data.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: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - wait_token: str = proto.Field( - proto.STRING, - number=2, - ) - success_on_timeout: bool = proto.Field( - proto.BOOL, - number=3, - ) - - -class ListActiveBreakpointsResponse(proto.Message): - r"""Response for listing active breakpoints. - - Attributes: - breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - next_wait_token: str = proto.Field( - proto.STRING, - number=2, - ) - wait_expired: bool = 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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_: data.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 42e4206..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py +++ /dev/null @@ -1,681 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -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 (MutableSequence[str]): - Optional parameters to be embedded into the - message. - """ - - format_: str = proto.Field( - proto.STRING, - number=1, - ) - parameters: MutableSequence[str] = 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. - - Values: - UNSPECIFIED (0): - Status doesn't refer to any particular input. - BREAKPOINT_SOURCE_LOCATION (3): - Status applies to the breakpoint and is - related to its location. - BREAKPOINT_CONDITION (4): - Status applies to the breakpoint and is - related to its condition. - BREAKPOINT_EXPRESSION (7): - Status applies to the breakpoint and is - related to its expressions. - BREAKPOINT_AGE (8): - Status applies to the breakpoint and is - related to its age. - VARIABLE_NAME (5): - Status applies to the entire variable. - VARIABLE_VALUE (6): - Status applies to variable value (variable - name is valid). - """ - UNSPECIFIED = 0 - BREAKPOINT_SOURCE_LOCATION = 3 - BREAKPOINT_CONDITION = 4 - BREAKPOINT_EXPRESSION = 7 - BREAKPOINT_AGE = 8 - VARIABLE_NAME = 5 - VARIABLE_VALUE = 6 - - is_error: bool = proto.Field( - proto.BOOL, - number=1, - ) - refers_to: Reference = proto.Field( - proto.ENUM, - number=2, - enum=Reference, - ) - description: 'FormatMessage' = 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: str = proto.Field( - proto.STRING, - number=1, - ) - line: int = proto.Field( - proto.INT32, - number=2, - ) - column: int = 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 (MutableSequence[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: str = proto.Field( - proto.STRING, - number=1, - ) - value: str = proto.Field( - proto.STRING, - number=2, - ) - type_: str = proto.Field( - proto.STRING, - number=6, - ) - members: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Variable', - ) - var_table_index: wrappers_pb2.Int32Value = proto.Field( - proto.MESSAGE, - number=4, - message=wrappers_pb2.Int32Value, - ) - status: 'StatusMessage' = 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 (MutableSequence[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_ (MutableSequence[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: str = proto.Field( - proto.STRING, - number=1, - ) - location: 'SourceLocation' = proto.Field( - proto.MESSAGE, - number=2, - message='SourceLocation', - ) - arguments: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Variable', - ) - locals_: MutableSequence['Variable'] = 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 (MutableSequence[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 (MutableSequence[google.cloud.debugger_v2.types.StackFrame]): - The stack at breakpoint time, where stack_frames[0] - represents the most recently entered function. - evaluated_expressions (MutableSequence[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 (MutableSequence[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 (MutableMapping[str, str]): - 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. - - Values: - CAPTURE (0): - Capture stack frame and variables and update - the breakpoint. The data is only captured once. - After that the breakpoint is set in a final - state. - LOG (1): - Log each breakpoint hit. The breakpoint - remains active until deleted or expired. - """ - CAPTURE = 0 - LOG = 1 - - class LogLevel(proto.Enum): - r"""Log severity levels. - - Values: - INFO (0): - Information log message. - WARNING (1): - Warning log message. - ERROR (2): - Error log message. - """ - INFO = 0 - WARNING = 1 - ERROR = 2 - - id: str = proto.Field( - proto.STRING, - number=1, - ) - action: Action = proto.Field( - proto.ENUM, - number=13, - enum=Action, - ) - location: 'SourceLocation' = proto.Field( - proto.MESSAGE, - number=2, - message='SourceLocation', - ) - condition: str = proto.Field( - proto.STRING, - number=3, - ) - expressions: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=4, - ) - log_message_format: str = proto.Field( - proto.STRING, - number=14, - ) - log_level: LogLevel = proto.Field( - proto.ENUM, - number=15, - enum=LogLevel, - ) - is_final_state: bool = proto.Field( - proto.BOOL, - number=5, - ) - create_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=11, - message=timestamp_pb2.Timestamp, - ) - final_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=12, - message=timestamp_pb2.Timestamp, - ) - user_email: str = proto.Field( - proto.STRING, - number=16, - ) - status: 'StatusMessage' = proto.Field( - proto.MESSAGE, - number=10, - message='StatusMessage', - ) - stack_frames: MutableSequence['StackFrame'] = proto.RepeatedField( - proto.MESSAGE, - number=7, - message='StackFrame', - ) - evaluated_expressions: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=8, - message='Variable', - ) - variable_table: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=9, - message='Variable', - ) - labels: MutableMapping[str, str] = 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 (MutableSequence[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 (MutableSequence[google.devtools.source.v1.source_context_pb2.ExtendedSourceContext]): - References to the locations and revisions of - the source code used in the deployed - application. - labels (MutableMapping[str, str]): - A set of custom debuggee properties, - populated by the agent, to be displayed to the - user. - """ - - id: str = proto.Field( - proto.STRING, - number=1, - ) - project: str = proto.Field( - proto.STRING, - number=2, - ) - uniquifier: str = proto.Field( - proto.STRING, - number=3, - ) - description: str = proto.Field( - proto.STRING, - number=4, - ) - is_inactive: bool = proto.Field( - proto.BOOL, - number=5, - ) - agent_version: str = proto.Field( - proto.STRING, - number=6, - ) - is_disabled: bool = proto.Field( - proto.BOOL, - number=7, - ) - status: 'StatusMessage' = proto.Field( - proto.MESSAGE, - number=8, - message='StatusMessage', - ) - source_contexts: MutableSequence[source_context_pb2.SourceContext] = proto.RepeatedField( - proto.MESSAGE, - number=9, - message=source_context_pb2.SourceContext, - ) - ext_source_contexts: MutableSequence[source_context_pb2.ExtendedSourceContext] = proto.RepeatedField( - proto.MESSAGE, - number=13, - message=source_context_pb2.ExtendedSourceContext, - ) - labels: MutableMapping[str, str] = 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 0c2fa0a..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py +++ /dev/null @@ -1,315 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_: data.Breakpoint = proto.Field( - proto.MESSAGE, - number=2, - message=data.Breakpoint, - ) - client_version: str = 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_: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_id: str = proto.Field( - proto.STRING, - number=2, - ) - client_version: str = 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_: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_id: str = proto.Field( - proto.STRING, - number=2, - ) - client_version: str = 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: data.Breakpoint.Action = proto.Field( - proto.ENUM, - number=1, - enum=data.Breakpoint.Action, - ) - - debuggee_id: str = proto.Field( - proto.STRING, - number=1, - ) - include_all_users: bool = proto.Field( - proto.BOOL, - number=2, - ) - include_inactive: bool = proto.Field( - proto.BOOL, - number=3, - ) - action: BreakpointActionValue = proto.Field( - proto.MESSAGE, - number=4, - message=BreakpointActionValue, - ) - strip_results: bool = proto.Field( - proto.BOOL, - number=5, - ) - wait_token: str = proto.Field( - proto.STRING, - number=6, - ) - client_version: str = proto.Field( - proto.STRING, - number=8, - ) - - -class ListBreakpointsResponse(proto.Message): - r"""Response for listing breakpoints. - - Attributes: - breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - next_wait_token: str = 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: str = proto.Field( - proto.STRING, - number=2, - ) - include_inactive: bool = proto.Field( - proto.BOOL, - number=3, - ) - client_version: str = proto.Field( - proto.STRING, - number=4, - ) - - -class ListDebuggeesResponse(proto.Message): - r"""Response for listing debuggees. - - Attributes: - debuggees (MutableSequence[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: MutableSequence[data.Debuggee] = 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 574c5ae..0000000 --- a/owl-bot-staging/v2/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/v2/noxfile.py b/owl-bot-staging/v2/noxfile.py deleted file mode 100644 index 02ef930..0000000 --- a/owl-bot-staging/v2/noxfile.py +++ /dev/null @@ -1,184 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", -] - -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") - -BLACK_VERSION = "black==22.3.0" -BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] -DEFAULT_PYTHON_VERSION = "3.11" - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", - "blacken", - "lint", - "lint_setup_py", -] - -@nox.session(python=ALL_PYTHON) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/debugger_v2/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -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=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - 'mypy', - 'types-requests', - 'types-protobuf' - ) - 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=DEFAULT_PYTHON_VERSION) -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", ""), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint(session): - """Run linters. - - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install("flake8", BLACK_VERSION) - session.run( - "black", - "--check", - *BLACK_PATHS, - ) - session.run("flake8", "google", "tests", "samples") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *BLACK_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py deleted file mode 100644 index 24f6ea0..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListActiveBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py deleted file mode 100644 index 67c27c7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListActiveBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py deleted file mode 100644 index b0ac801..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDebuggee -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = await client.register_debuggee(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py deleted file mode 100644 index 99f6287..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDebuggee -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = client.register_debuggee(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py deleted file mode 100644 index e74e3e7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateActiveBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py deleted file mode 100644 index 10a9948..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateActiveBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py deleted file mode 100644 index b445c89..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - await client.delete_breakpoint(request=request) - - -# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py deleted file mode 100644 index 01599f2..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - client.delete_breakpoint(request=request) - - -# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py deleted file mode 100644 index 7074dcf..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.get_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py deleted file mode 100644 index 3f7ebd0..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.get_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py deleted file mode 100644 index 816dd2b..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py deleted file mode 100644 index 4f65108..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py deleted file mode 100644 index fda422c..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListDebuggees -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_debuggees(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py deleted file mode 100644 index 246e83f..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListDebuggees -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_debuggees(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py deleted file mode 100644 index 6267555..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.set_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py deleted file mode 100644 index 22b41d7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.set_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json deleted file mode 100644 index ab6c88f..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json +++ /dev/null @@ -1,1369 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.devtools.clouddebugger.v2", - "version": "v2" - } - ], - "language": "PYTHON", - "name": "google-cloud-debugger-client", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.list_active_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "ListActiveBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", - "shortName": "list_active_breakpoints" - }, - "description": "Sample for ListActiveBreakpoints", - "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.list_active_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "ListActiveBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", - "shortName": "list_active_breakpoints" - }, - "description": "Sample for ListActiveBreakpoints", - "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.register_debuggee", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "RegisterDebuggee" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" - }, - { - "name": "debuggee", - "type": "google.cloud.debugger_v2.types.Debuggee" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", - "shortName": "register_debuggee" - }, - "description": "Sample for RegisterDebuggee", - "file": "clouddebugger_v2_generated_controller2_register_debuggee_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_async", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_register_debuggee_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.register_debuggee", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "RegisterDebuggee" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" - }, - { - "name": "debuggee", - "type": "google.cloud.debugger_v2.types.Debuggee" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", - "shortName": "register_debuggee" - }, - "description": "Sample for RegisterDebuggee", - "file": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.update_active_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "UpdateActiveBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", - "shortName": "update_active_breakpoint" - }, - "description": "Sample for UpdateActiveBreakpoint", - "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.update_active_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "UpdateActiveBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", - "shortName": "update_active_breakpoint" - }, - "description": "Sample for UpdateActiveBreakpoint", - "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.delete_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "DeleteBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_breakpoint" - }, - "description": "Sample for DeleteBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.delete_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "DeleteBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_breakpoint" - }, - "description": "Sample for DeleteBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.get_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "GetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", - "shortName": "get_breakpoint" - }, - "description": "Sample for GetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_async", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.get_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "GetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", - "shortName": "get_breakpoint" - }, - "description": "Sample for GetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", - "shortName": "list_breakpoints" - }, - "description": "Sample for ListBreakpoints", - "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.list_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", - "shortName": "list_breakpoints" - }, - "description": "Sample for ListBreakpoints", - "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_debuggees", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListDebuggees" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" - }, - { - "name": "project", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", - "shortName": "list_debuggees" - }, - "description": "Sample for ListDebuggees", - "file": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.list_debuggees", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListDebuggees" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" - }, - { - "name": "project", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", - "shortName": "list_debuggees" - }, - "description": "Sample for ListDebuggees", - "file": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.set_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "SetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", - "shortName": "set_breakpoint" - }, - "description": "Sample for SetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.set_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "SetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", - "shortName": "set_breakpoint" - }, - "description": "Sample for SetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py" - } - ] -} 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 9802c14..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 2022 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 4295418..0000000 --- a/owl-bot-staging/v2/setup.py +++ /dev/null @@ -1,90 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-cloud-debugger-client' - - -description = "Google Cloud Debugger Client API client library" - -version = {} -with open(os.path.join(package_root, 'google/cloud/debugger/gapic_version.py')) as fp: - exec(fp.read(), version) -version = version["__version__"] - -if version[0] == "0": - release_status = "Development Status :: 4 - Beta" -else: - release_status = "Development Status :: 5 - Production/Stable" - -dependencies = [ - "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - "proto-plus >= 1.22.0, <2.0.0dev", - "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", - "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", -] -url = "https://github.com/googleapis/python-debugger-client" - -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() - -packages = [ - package - for package in setuptools.PEP420PackageFinder.find() - if package.startswith("google") -] - -namespaces = ["google", "google.cloud"] - -setuptools.setup( - name=name, - version=version, - description=description, - long_description=readme, - author="Google LLC", - author_email="googleapis-packages@google.com", - license="Apache 2.0", - url=url, - classifiers=[ - release_status, - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - namespace_packages=namespaces, - install_requires=dependencies, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/v2/testing/constraints-3.10.txt b/owl-bot-staging/v2/testing/constraints-3.10.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.10.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.11.txt b/owl-bot-staging/v2/testing/constraints-3.11.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.11.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.12.txt b/owl-bot-staging/v2/testing/constraints-3.12.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.12.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.7.txt b/owl-bot-staging/v2/testing/constraints-3.7.txt deleted file mode 100644 index 6c44adf..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.7.txt +++ /dev/null @@ -1,9 +0,0 @@ -# This constraints file is used to check that lower bounds -# are correct in setup.py -# List all library dependencies and extras in this file. -# Pin the version to the lower bound. -# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.0 -proto-plus==1.22.0 -protobuf==3.19.5 diff --git a/owl-bot-staging/v2/testing/constraints-3.8.txt b/owl-bot-staging/v2/testing/constraints-3.8.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.8.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.9.txt b/owl-bot-staging/v2/testing/constraints-3.9.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.9.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v2/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 5058381..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py +++ /dev/null @@ -1,2551 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -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,transport_name", [ - (Controller2Client, "grpc"), - (Controller2AsyncClient, "grpc_asyncio"), - (Controller2Client, "rest"), -]) -def test_controller2_client_from_service_account_info(client_class, transport_name): - 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, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.Controller2GrpcTransport, "grpc"), - (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), - (transports.Controller2RestTransport, "rest"), -]) -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,transport_name", [ - (Controller2Client, "grpc"), - (Controller2AsyncClient, "grpc_asyncio"), - (Controller2Client, "rest"), -]) -def test_controller2_client_from_service_account_file(client_class, transport_name): - 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", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -def test_controller2_client_get_transport_class(): - transport = Controller2Client.get_transport_class() - available_transports = [ - transports.Controller2GrpcTransport, - transports.Controller2RestTransport, - ] - 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"), - (Controller2Client, transports.Controller2RestTransport, "rest"), -]) -@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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - 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=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@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"), - (Controller2Client, transports.Controller2RestTransport, "rest", "true"), - (Controller2Client, transports.Controller2RestTransport, "rest", "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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - -@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"), - (Controller2Client, transports.Controller2RestTransport, "rest"), -]) -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, - api_audience=None, - ) - -@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), - (Controller2Client, transports.Controller2RestTransport, "rest", None), -]) -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, - api_audience=None, - ) - -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, - api_audience=None, - ) - - -@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, - api_audience=None, - ) - - # 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_field_headers(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.ListActiveBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # 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: - call.return_value = controller.ListActiveBreakpointsResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_active_breakpoints_field_headers_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.ListActiveBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # 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: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.UpdateActiveBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint.id = 'id_value' - - # 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: - call.return_value = controller.UpdateActiveBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_active_breakpoint_field_headers_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.UpdateActiveBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint.id = 'id_value' - - # 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: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', - ) in kw['metadata'] - - -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'), - ) - - -@pytest.mark.parametrize("request_type", [ - controller.RegisterDebuggeeRequest, - dict, -]) -def test_register_debuggee_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.register_debuggee(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.RegisterDebuggeeResponse) - - -def test_register_debuggee_rest_required_fields(request_type=controller.RegisterDebuggeeRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.register_debuggee(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_register_debuggee_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.register_debuggee._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("debuggee", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_register_debuggee_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_register_debuggee") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_register_debuggee") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.RegisterDebuggeeRequest.pb(controller.RegisterDebuggeeRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.RegisterDebuggeeResponse.to_json(controller.RegisterDebuggeeResponse()) - - request = controller.RegisterDebuggeeRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.RegisterDebuggeeResponse() - - client.register_debuggee(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_register_debuggee_rest_bad_request(transport: str = 'rest', request_type=controller.RegisterDebuggeeRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.register_debuggee(request) - - -def test_register_debuggee_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {} - - # get truthy value for each flattened field - mock_args = dict( - debuggee=data.Debuggee(id='id_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.register_debuggee(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/register" % client.transport._host, args[1]) - - -def test_register_debuggee_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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'), - ) - - -def test_register_debuggee_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - controller.ListActiveBreakpointsRequest, - dict, -]) -def test_list_active_breakpoints_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse( - next_wait_token='next_wait_token_value', - wait_expired=True, - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_active_breakpoints(request) - - # 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_rest_required_fields(request_type=controller.ListActiveBreakpointsRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("success_on_timeout", "wait_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_active_breakpoints(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_active_breakpoints_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_active_breakpoints._get_unset_required_fields({}) - assert set(unset_fields) == (set(("successOnTimeout", "waitToken", )) & set(("debuggeeId", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_active_breakpoints_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_list_active_breakpoints") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_list_active_breakpoints") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.ListActiveBreakpointsRequest.pb(controller.ListActiveBreakpointsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.ListActiveBreakpointsResponse.to_json(controller.ListActiveBreakpointsResponse()) - - request = controller.ListActiveBreakpointsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.ListActiveBreakpointsResponse() - - client.list_active_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_active_breakpoints_rest_bad_request(transport: str = 'rest', request_type=controller.ListActiveBreakpointsRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_active_breakpoints(request) - - -def test_list_active_breakpoints_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_active_breakpoints(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) - - -def test_list_active_breakpoints_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_active_breakpoints_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - controller.UpdateActiveBreakpointRequest, - dict, -]) -def test_update_active_breakpoint_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.update_active_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.UpdateActiveBreakpointResponse) - - -def test_update_active_breakpoint_rest_required_fields(request_type=controller.UpdateActiveBreakpointRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "put", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.update_active_breakpoint(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_update_active_breakpoint_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.update_active_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("debuggeeId", "breakpoint", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_active_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_update_active_breakpoint") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_update_active_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.UpdateActiveBreakpointRequest.pb(controller.UpdateActiveBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.UpdateActiveBreakpointResponse.to_json(controller.UpdateActiveBreakpointResponse()) - - request = controller.UpdateActiveBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.UpdateActiveBreakpointResponse() - - client.update_active_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_update_active_breakpoint_rest_bad_request(transport: str = 'rest', request_type=controller.UpdateActiveBreakpointRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.update_active_breakpoint(request) - - -def test_update_active_breakpoint_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.update_active_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}" % client.transport._host, args[1]) - - -def test_update_active_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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'), - ) - - -def test_update_active_breakpoint_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -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, - transports.Controller2RestTransport, -]) -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() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = Controller2Client.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -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() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -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", - [ - transports.Controller2GrpcTransport, - transports.Controller2GrpcAsyncIOTransport, - transports.Controller2RestTransport, - ], -) -def test_controller2_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@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_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.Controller2RestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_controller2_host_no_port(transport_name): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_controller2_host_with_port(transport_name): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_controller2_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = Controller2Client( - credentials=creds1, - transport=transport_name, - ) - client2 = Controller2Client( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.register_debuggee._session - session2 = client2.transport.register_debuggee._session - assert session1 != session2 - session1 = client1.transport.list_active_breakpoints._session - session2 = client2.transport.list_active_breakpoints._session - assert session1 != session2 - session1 = client1.transport.update_active_breakpoint._session - session2 = client2.transport.update_active_breakpoint._session - assert session1 != session2 -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 = { - "rest": "_session", - "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 = [ - 'rest', - '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, - api_audience=None, - ) 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 ad07b63..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py +++ /dev/null @@ -1,3628 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -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,transport_name", [ - (Debugger2Client, "grpc"), - (Debugger2AsyncClient, "grpc_asyncio"), - (Debugger2Client, "rest"), -]) -def test_debugger2_client_from_service_account_info(client_class, transport_name): - 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, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.Debugger2GrpcTransport, "grpc"), - (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), - (transports.Debugger2RestTransport, "rest"), -]) -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,transport_name", [ - (Debugger2Client, "grpc"), - (Debugger2AsyncClient, "grpc_asyncio"), - (Debugger2Client, "rest"), -]) -def test_debugger2_client_from_service_account_file(client_class, transport_name): - 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", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -def test_debugger2_client_get_transport_class(): - transport = Debugger2Client.get_transport_class() - available_transports = [ - transports.Debugger2GrpcTransport, - transports.Debugger2RestTransport, - ] - 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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest"), -]) -@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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - 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=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest", "true"), - (Debugger2Client, transports.Debugger2RestTransport, "rest", "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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - -@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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest"), -]) -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, - api_audience=None, - ) - -@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), - (Debugger2Client, transports.Debugger2RestTransport, "rest", None), -]) -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, - api_audience=None, - ) - -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, - api_audience=None, - ) - - -@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, - api_audience=None, - ) - - # 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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.SetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - call.return_value = debugger.SetBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_set_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.SetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.GetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - call.return_value = debugger.GetBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.GetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.DeleteBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - call.return_value = None - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.DeleteBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.ListBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - call.return_value = debugger.ListBreakpointsResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_breakpoints_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.ListBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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', - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.SetBreakpointRequest, - dict, -]) -def test_set_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.set_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.SetBreakpointResponse) - - -def test_set_breakpoint_rest_required_fields(request_type=debugger.SetBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("breakpoint_", "client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.set_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_set_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.set_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("breakpoint", "clientVersion", )) & set(("debuggeeId", "breakpoint", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_set_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_set_breakpoint") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_set_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.SetBreakpointRequest.pb(debugger.SetBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.SetBreakpointResponse.to_json(debugger.SetBreakpointResponse()) - - request = debugger.SetBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.SetBreakpointResponse() - - client.set_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_set_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.SetBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.set_breakpoint(request) - - -def test_set_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.set_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/set" % client.transport._host, args[1]) - - -def test_set_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_set_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.GetBreakpointRequest, - dict, -]) -def test_get_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.get_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.GetBreakpointResponse) - - -def test_get_breakpoint_rest_required_fields(request_type=debugger.GetBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["breakpoint_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["breakpointId"] = 'breakpoint_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "breakpointId" in jsonified_request - assert jsonified_request["breakpointId"] == 'breakpoint_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.get_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_get_breakpoint") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_get_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.GetBreakpointRequest.pb(debugger.GetBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.GetBreakpointResponse.to_json(debugger.GetBreakpointResponse()) - - request = debugger.GetBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.GetBreakpointResponse() - - client.get_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.GetBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.get_breakpoint(request) - - -def test_get_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.get_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) - - -def test_get_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_get_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.DeleteBreakpointRequest, - dict, -]) -def test_delete_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.delete_breakpoint(request) - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_breakpoint_rest_required_fields(request_type=debugger.DeleteBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["breakpoint_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["breakpointId"] = 'breakpoint_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "breakpointId" in jsonified_request - assert jsonified_request["breakpointId"] == 'breakpoint_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = None - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "delete", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.delete_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_delete_breakpoint") as pre: - pre.assert_not_called() - pb_message = debugger.DeleteBreakpointRequest.pb(debugger.DeleteBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - - request = debugger.DeleteBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.delete_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_delete_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.DeleteBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.delete_breakpoint(request) - - -def test_delete_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.delete_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) - - -def test_delete_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_delete_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.ListBreakpointsRequest, - dict, -]) -def test_list_breakpoints_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse( - next_wait_token='next_wait_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_breakpoints(request) - - # 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_rest_required_fields(request_type=debugger.ListBreakpointsRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("action", "client_version", "include_all_users", "include_inactive", "strip_results", "wait_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_breakpoints(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_breakpoints_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_breakpoints._get_unset_required_fields({}) - assert set(unset_fields) == (set(("action", "clientVersion", "includeAllUsers", "includeInactive", "stripResults", "waitToken", )) & set(("debuggeeId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_breakpoints_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_list_breakpoints") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_breakpoints") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.ListBreakpointsRequest.pb(debugger.ListBreakpointsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.ListBreakpointsResponse.to_json(debugger.ListBreakpointsResponse()) - - request = debugger.ListBreakpointsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.ListBreakpointsResponse() - - client.list_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_breakpoints_rest_bad_request(transport: str = 'rest', request_type=debugger.ListBreakpointsRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_breakpoints(request) - - -def test_list_breakpoints_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_breakpoints(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) - - -def test_list_breakpoints_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_breakpoints_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.ListDebuggeesRequest, - dict, -]) -def test_list_debuggees_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_debuggees(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.ListDebuggeesResponse) - - -def test_list_debuggees_rest_required_fields(request_type=debugger.ListDebuggeesRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["project"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "project" not in jsonified_request - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "project" in jsonified_request - assert jsonified_request["project"] == request_init["project"] - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["project"] = 'project_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", "include_inactive", "project", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "project" in jsonified_request - assert jsonified_request["project"] == 'project_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_debuggees(request) - - expected_params = [ - ( - "project", - "", - ), - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_debuggees_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_debuggees._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", "includeInactive", "project", )) & set(("project", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_debuggees_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_list_debuggees") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_debuggees") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.ListDebuggeesRequest.pb(debugger.ListDebuggeesRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.ListDebuggeesResponse.to_json(debugger.ListDebuggeesResponse()) - - request = debugger.ListDebuggeesRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.ListDebuggeesResponse() - - client.list_debuggees(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_debuggees_rest_bad_request(transport: str = 'rest', request_type=debugger.ListDebuggeesRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_debuggees(request) - - -def test_list_debuggees_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {} - - # get truthy value for each flattened field - mock_args = dict( - project='project_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_debuggees(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees" % client.transport._host, args[1]) - - -def test_list_debuggees_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_debuggees_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -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, - transports.Debugger2RestTransport, -]) -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() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = Debugger2Client.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -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() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -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", - [ - transports.Debugger2GrpcTransport, - transports.Debugger2GrpcAsyncIOTransport, - transports.Debugger2RestTransport, - ], -) -def test_debugger2_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@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_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.Debugger2RestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_debugger2_host_no_port(transport_name): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_debugger2_host_with_port(transport_name): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_debugger2_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = Debugger2Client( - credentials=creds1, - transport=transport_name, - ) - client2 = Debugger2Client( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.set_breakpoint._session - session2 = client2.transport.set_breakpoint._session - assert session1 != session2 - session1 = client1.transport.get_breakpoint._session - session2 = client2.transport.get_breakpoint._session - assert session1 != session2 - session1 = client1.transport.delete_breakpoint._session - session2 = client2.transport.delete_breakpoint._session - assert session1 != session2 - session1 = client1.transport.list_breakpoints._session - session2 = client2.transport.list_breakpoints._session - assert session1 != session2 - session1 = client1.transport.list_debuggees._session - session2 = client2.transport.list_debuggees._session - assert session1 != session2 -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 = { - "rest": "_session", - "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 = [ - 'rest', - '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, - api_audience=None, - ) From d95b5b4224585266b255b32b8629a42d1df7e997 Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 5 Jul 2023 22:49:42 +0000 Subject: [PATCH 09/10] chore: Update gapic-generator-python to v1.11.1 PiperOrigin-RevId: 545769621 Source-Link: https://github.com/googleapis/googleapis/commit/cc2f031396e0cda5dd89f191493fe9eddff47233 Source-Link: https://github.com/googleapis/googleapis-gen/commit/1a46ae7652ef98a86c2bc232b6da0412e9f30bdb Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMWE0NmFlNzY1MmVmOThhODZjMmJjMjMyYjZkYTA0MTJlOWYzMGJkYiJ9 --- owl-bot-staging/v2/.coveragerc | 13 + owl-bot-staging/v2/.flake8 | 33 + 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 | 6 + owl-bot-staging/v2/docs/index.rst | 7 + .../v2/google/cloud/debugger/__init__.py | 75 + .../v2/google/cloud/debugger/gapic_version.py | 16 + .../v2/google/cloud/debugger/py.typed | 2 + .../v2/google/cloud/debugger_v2/__init__.py | 76 + .../cloud/debugger_v2/gapic_metadata.json | 167 + .../google/cloud/debugger_v2/gapic_version.py | 16 + .../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 | 566 +++ .../services/controller2/client.py | 747 ++++ .../controller2/transports/__init__.py | 38 + .../services/controller2/transports/base.py | 191 + .../services/controller2/transports/grpc.py | 369 ++ .../controller2/transports/grpc_asyncio.py | 368 ++ .../services/controller2/transports/rest.py | 553 +++ .../services/debugger2/__init__.py | 22 + .../services/debugger2/async_client.py | 806 ++++ .../debugger_v2/services/debugger2/client.py | 973 +++++ .../services/debugger2/transports/__init__.py | 38 + .../services/debugger2/transports/base.py | 234 ++ .../services/debugger2/transports/grpc.py | 381 ++ .../debugger2/transports/grpc_asyncio.py | 380 ++ .../services/debugger2/transports/rest.py | 729 ++++ .../cloud/debugger_v2/types/__init__.py | 68 + .../cloud/debugger_v2/types/controller.py | 176 + .../v2/google/cloud/debugger_v2/types/data.py | 681 ++++ .../cloud/debugger_v2/types/debugger.py | 315 ++ owl-bot-staging/v2/mypy.ini | 3 + owl-bot-staging/v2/noxfile.py | 184 + ...ntroller2_list_active_breakpoints_async.py | 52 + ...ontroller2_list_active_breakpoints_sync.py | 52 + ...ted_controller2_register_debuggee_async.py | 51 + ...ated_controller2_register_debuggee_sync.py | 51 + ...troller2_update_active_breakpoint_async.py | 52 + ...ntroller2_update_active_breakpoint_sync.py | 52 + ...rated_debugger2_delete_breakpoint_async.py | 52 + ...erated_debugger2_delete_breakpoint_sync.py | 52 + ...enerated_debugger2_get_breakpoint_async.py | 54 + ...generated_debugger2_get_breakpoint_sync.py | 54 + ...erated_debugger2_list_breakpoints_async.py | 53 + ...nerated_debugger2_list_breakpoints_sync.py | 53 + ...enerated_debugger2_list_debuggees_async.py | 53 + ...generated_debugger2_list_debuggees_sync.py | 53 + ...enerated_debugger2_set_breakpoint_async.py | 53 + ...generated_debugger2_set_breakpoint_sync.py | 53 + ...data_google.devtools.clouddebugger.v2.json | 1369 +++++++ .../v2/scripts/fixup_debugger_v2_keywords.py | 183 + owl-bot-staging/v2/setup.py | 90 + .../v2/testing/constraints-3.10.txt | 6 + .../v2/testing/constraints-3.11.txt | 6 + .../v2/testing/constraints-3.12.txt | 6 + .../v2/testing/constraints-3.7.txt | 9 + .../v2/testing/constraints-3.8.txt | 6 + .../v2/testing/constraints-3.9.txt | 6 + 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 | 2551 ++++++++++++ .../unit/gapic/debugger_v2/test_debugger2.py | 3628 +++++++++++++++++ 71 files changed, 17482 insertions(+) create mode 100644 owl-bot-staging/v2/.coveragerc create mode 100644 owl-bot-staging/v2/.flake8 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/gapic_version.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/gapic_version.py 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/controller2/transports/rest.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/services/debugger2/transports/rest.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/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py create mode 100644 owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json 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/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/v2/testing/constraints-3.9.txt 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..9620812 --- /dev/null +++ b/owl-bot-staging/v2/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/debugger/__init__.py + google/cloud/debugger/gapic_version.py +exclude_lines = + # Re-enable the standard pragma + pragma: NO COVER + # Ignore debug-only repr + def __repr__ diff --git a/owl-bot-staging/v2/.flake8 b/owl-bot-staging/v2/.flake8 new file mode 100644 index 0000000..29227d4 --- /dev/null +++ b/owl-bot-staging/v2/.flake8 @@ -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 +# +# https://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. + +# Generated by synthtool. DO NOT EDIT! +[flake8] +ignore = E203, E266, E501, W503 +exclude = + # Exclude generated code. + **/proto/** + **/gapic/** + **/services/** + **/types/** + *_pb2.py + + # Standard linting exemptions. + **/.nox/** + __pycache__, + .git, + *.pyc, + conf.py 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..4ad5ea1 --- /dev/null +++ b/owl-bot-staging/v2/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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"2022, 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..0106467 --- /dev/null +++ b/owl-bot-staging/v2/docs/debugger_v2/types.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Debugger v2 API +====================================== + +.. automodule:: google.cloud.debugger_v2.types + :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..1228468 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger/__init__.py @@ -0,0 +1,75 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 import gapic_version as package_version + +__version__ = package_version.__version__ + + +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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py new file mode 100644 index 0000000..30274cc --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +__version__ = "0.0.0" # {x-release-please-version} 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..c774017 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py @@ -0,0 +1,76 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 import gapic_version as package_version + +__version__ = package_version.__version__ + + +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..f0d8a90 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json @@ -0,0 +1,167 @@ + { + "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" + ] + } + } + }, + "rest": { + "libraryClient": "Controller2Client", + "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" + ] + } + } + }, + "rest": { + "libraryClient": "Debugger2Client", + "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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py new file mode 100644 index 0000000..30274cc --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +__version__ = "0.0.0" # {x-release-please-version} 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..e8e1c38 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..e010a73 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..e81f163 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py @@ -0,0 +1,566 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 variable 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: Optional[ga_credentials.Credentials] = None, + transport: Union[str, Controller2Transport] = "grpc_asyncio", + client_options: Optional[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: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, + *, + debuggee: Optional[data.Debuggee] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = await client.register_debuggee(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint.id", request.breakpoint.id), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self) -> "Controller2AsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..7330718 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py @@ -0,0 +1,747 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 +from .transports.rest import Controller2RestTransport + + +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 + _transport_registry["rest"] = Controller2RestTransport + + def get_transport_class(cls, + label: Optional[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 variable 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: Optional[Union[str, Controller2Transport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() + client_options = cast(client_options_lib.ClientOptions, client_options) + + 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, + api_audience=client_options.api_audience, + ) + + def register_debuggee(self, + request: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, + *, + debuggee: Optional[data.Debuggee] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = client.register_debuggee(request=request) + + # Handle the response + print(response) + + 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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_active_breakpoint(self, + request: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + 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. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint.id", request.breakpoint.id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "Controller2Client": + 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() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..0381ff4 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +from .rest import Controller2RestTransport +from .rest import Controller2RestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] +_transport_registry['grpc'] = Controller2GrpcTransport +_transport_registry['grpc_asyncio'] = Controller2GrpcAsyncIOTransport +_transport_registry['rest'] = Controller2RestTransport + +__all__ = ( + 'Controller2Transport', + 'Controller2GrpcTransport', + 'Controller2GrpcAsyncIOTransport', + 'Controller2RestTransport', + 'Controller2RestInterceptor', +) 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..8e480a6 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py @@ -0,0 +1,191 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +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: Optional[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, + api_audience: Optional[str] = None, + **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. + """ + + 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) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # 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 + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + 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() + + @property + def kind(self) -> str: + 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..09e2efa --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py @@ -0,0 +1,369 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[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() + + @property + def kind(self) -> str: + return "grpc" + + +__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..ae65db1 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py @@ -0,0 +1,368 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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/controller2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py new file mode 100644 index 0000000..e172241 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py @@ -0,0 +1,553 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +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 .base import Controller2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class Controller2RestInterceptor: + """Interceptor for Controller2. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the Controller2RestTransport. + + .. code-block:: python + class MyCustomController2Interceptor(Controller2RestInterceptor): + def pre_list_active_breakpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_active_breakpoints(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_register_debuggee(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_register_debuggee(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_active_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_active_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + transport = Controller2RestTransport(interceptor=MyCustomController2Interceptor()) + client = Controller2Client(transport=transport) + + + """ + def pre_list_active_breakpoints(self, request: controller.ListActiveBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.ListActiveBreakpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_active_breakpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_list_active_breakpoints(self, response: controller.ListActiveBreakpointsResponse) -> controller.ListActiveBreakpointsResponse: + """Post-rpc interceptor for list_active_breakpoints + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + def pre_register_debuggee(self, request: controller.RegisterDebuggeeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.RegisterDebuggeeRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for register_debuggee + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_register_debuggee(self, response: controller.RegisterDebuggeeResponse) -> controller.RegisterDebuggeeResponse: + """Post-rpc interceptor for register_debuggee + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + def pre_update_active_breakpoint(self, request: controller.UpdateActiveBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.UpdateActiveBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_active_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Controller2 server. + """ + return request, metadata + + def post_update_active_breakpoint(self, response: controller.UpdateActiveBreakpointResponse) -> controller.UpdateActiveBreakpointResponse: + """Post-rpc interceptor for update_active_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Controller2 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class Controller2RestStub: + _session: AuthorizedSession + _host: str + _interceptor: Controller2RestInterceptor + + +class Controller2RestTransport(Controller2Transport): + """REST 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 JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[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, + url_scheme: str = 'https', + interceptor: Optional[Controller2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> 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 ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` 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 are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or Controller2RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _ListActiveBreakpoints(Controller2RestStub): + def __hash__(self): + return hash("ListActiveBreakpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.ListActiveBreakpointsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.ListActiveBreakpointsResponse: + r"""Call the list active breakpoints method over HTTP. + + Args: + request (~.controller.ListActiveBreakpointsRequest): + The request object. Request to list active breakpoints. + 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: + ~.controller.ListActiveBreakpointsResponse: + Response for listing active + breakpoints. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints', + }, + ] + request, metadata = self._interceptor.pre_list_active_breakpoints(request, metadata) + pb_request = controller.ListActiveBreakpointsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.ListActiveBreakpointsResponse() + pb_resp = controller.ListActiveBreakpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_active_breakpoints(resp) + return resp + + class _RegisterDebuggee(Controller2RestStub): + def __hash__(self): + return hash("RegisterDebuggee") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.RegisterDebuggeeRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.RegisterDebuggeeResponse: + r"""Call the register debuggee method over HTTP. + + Args: + request (~.controller.RegisterDebuggeeRequest): + The request object. Request to register a debuggee. + 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: + ~.controller.RegisterDebuggeeResponse: + Response for registering a debuggee. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/controller/debuggees/register', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_register_debuggee(request, metadata) + pb_request = controller.RegisterDebuggeeRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.RegisterDebuggeeResponse() + pb_resp = controller.RegisterDebuggeeResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_register_debuggee(resp) + return resp + + class _UpdateActiveBreakpoint(Controller2RestStub): + def __hash__(self): + return hash("UpdateActiveBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: controller.UpdateActiveBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> controller.UpdateActiveBreakpointResponse: + r"""Call the update active breakpoint method over HTTP. + + Args: + request (~.controller.UpdateActiveBreakpointRequest): + The request object. Request to update an active + breakpoint. + 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: + ~.controller.UpdateActiveBreakpointResponse: + Response for updating an active + breakpoint. The message is defined to + allow future extensions. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'put', + 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}', + 'body': '*', + }, + ] + request, metadata = self._interceptor.pre_update_active_breakpoint(request, metadata) + pb_request = controller.UpdateActiveBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = controller.UpdateActiveBreakpointResponse() + pb_resp = controller.UpdateActiveBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_active_breakpoint(resp) + return resp + + @property + def list_active_breakpoints(self) -> Callable[ + [controller.ListActiveBreakpointsRequest], + controller.ListActiveBreakpointsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListActiveBreakpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def register_debuggee(self) -> Callable[ + [controller.RegisterDebuggeeRequest], + controller.RegisterDebuggeeResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._RegisterDebuggee(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_active_breakpoint(self) -> Callable[ + [controller.UpdateActiveBreakpointRequest], + controller.UpdateActiveBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._UpdateActiveBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'Controller2RestTransport', +) 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..5d7f609 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..07420ee --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py @@ -0,0 +1,806 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 variable 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: Optional[ga_credentials.Credentials] = None, + transport: Union[str, Debugger2Transport] = "grpc_asyncio", + client_options: Optional[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: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Sets the breakpoint to the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.set_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Gets breakpoint information. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.get_breakpoint(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # 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: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the breakpoint from the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + await client.delete_breakpoint(request=request) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def list_breakpoints(self, + request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Lists all breakpoints for the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_breakpoints(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # 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: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, + *, + project: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Lists all the debuggees that the user has access to. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + async def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_debuggees(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[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) -> "Debugger2AsyncClient": + return self + + async def __aexit__(self, exc_type, exc, tb): + await self.transport.close() + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..7e52f8d --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py @@ -0,0 +1,973 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 +from .transports.rest import Debugger2RestTransport + + +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 + _transport_registry["rest"] = Debugger2RestTransport + + def get_transport_class(cls, + label: Optional[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 variable 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: Optional[Union[str, Debugger2Transport]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() + client_options = cast(client_options_lib.ClientOptions, client_options) + + 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, + api_audience=client_options.api_audience, + ) + + def set_breakpoint(self, + request: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_: Optional[data.Breakpoint] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.SetBreakpointResponse: + r"""Sets the breakpoint to the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.set_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_breakpoint(self, + request: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.GetBreakpointResponse: + r"""Gets breakpoint information. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.get_breakpoint(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_breakpoint(self, + request: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + breakpoint_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes the breakpoint from the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + client.delete_breakpoint(request=request) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + ("breakpoint_id", request.breakpoint_id), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def list_breakpoints(self, + request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, + *, + debuggee_id: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListBreakpointsResponse: + r"""Lists all breakpoints for the debuggee. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_breakpoints(request=request) + + # Handle the response + print(response) + + 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] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("debuggee_id", request.debuggee_id), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def list_debuggees(self, + request: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, + *, + project: Optional[str] = None, + client_version: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> debugger.ListDebuggeesResponse: + r"""Lists all the debuggees that the user has access to. + + .. code-block:: python + + # This snippet has been automatically generated and should be regarded as a + # code template only. + # It will require modifications to work: + # - It may require correct/in-range values for request initialization. + # - It may require specifying regional endpoints when creating the service + # client as shown in: + # https://googleapis.dev/python/google-api-core/latest/client_options.html + from google.cloud import debugger_v2 + + def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_debuggees(request=request) + + # Handle the response + print(response) + + 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) -> "Debugger2Client": + 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() + + + + + + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +__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..cd9dd46 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +from .rest import Debugger2RestTransport +from .rest import Debugger2RestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] +_transport_registry['grpc'] = Debugger2GrpcTransport +_transport_registry['grpc_asyncio'] = Debugger2GrpcAsyncIOTransport +_transport_registry['rest'] = Debugger2RestTransport + +__all__ = ( + 'Debugger2Transport', + 'Debugger2GrpcTransport', + 'Debugger2GrpcAsyncIOTransport', + 'Debugger2RestTransport', + 'Debugger2RestInterceptor', +) 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..c4afc0c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py @@ -0,0 +1,234 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +from google.cloud.debugger_v2 import gapic_version as package_version + +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 + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +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: Optional[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, + api_audience: Optional[str] = None, + **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. + """ + + 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) + # Don't apply audience if the credentials file passed from user. + if hasattr(credentials, "with_gdch_audience"): + credentials = credentials.with_gdch_audience(api_audience if api_audience else host) + + # 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 + + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + 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() + + @property + def kind(self) -> str: + 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..fbb3374 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py @@ -0,0 +1,381 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[grpc.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[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() + + @property + def kind(self) -> str: + return "grpc" + + +__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..eb6eadc --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py @@ -0,0 +1,380 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[aio.Channel] = None, + api_mtls_endpoint: Optional[str] = None, + client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, + ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, + client_cert_source_for_mtls: Optional[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, + api_audience: Optional[str] = None, + ) -> 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, + api_audience=api_audience, + ) + + 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/services/debugger2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py new file mode 100644 index 0000000..17e5c4f --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py @@ -0,0 +1,729 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore +import json # type: ignore +import grpc # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore +from google.auth import credentials as ga_credentials # type: ignore +from google.api_core import exceptions as core_exceptions +from google.api_core import retry as retries +from google.api_core import rest_helpers +from google.api_core import rest_streaming +from google.api_core import path_template +from google.api_core import gapic_v1 + +from google.protobuf import json_format +from requests import __version__ as requests_version +import dataclasses +import re +from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union +import warnings + +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 debugger +from google.protobuf import empty_pb2 # type: ignore + +from .base import Debugger2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO + + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, + grpc_version=None, + rest_version=requests_version, +) + + +class Debugger2RestInterceptor: + """Interceptor for Debugger2. + + Interceptors are used to manipulate requests, request metadata, and responses + in arbitrary ways. + Example use cases include: + * Logging + * Verifying requests according to service or custom semantics + * Stripping extraneous information from responses + + These use cases and more can be enabled by injecting an + instance of a custom subclass when constructing the Debugger2RestTransport. + + .. code-block:: python + class MyCustomDebugger2Interceptor(Debugger2RestInterceptor): + def pre_delete_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_breakpoints(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_breakpoints(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_list_debuggees(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_list_debuggees(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_set_breakpoint(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_set_breakpoint(self, response): + logging.log(f"Received response: {response}") + return response + + transport = Debugger2RestTransport(interceptor=MyCustomDebugger2Interceptor()) + client = Debugger2Client(transport=transport) + + + """ + def pre_delete_breakpoint(self, request: debugger.DeleteBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.DeleteBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def pre_get_breakpoint(self, request: debugger.GetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.GetBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_get_breakpoint(self, response: debugger.GetBreakpointResponse) -> debugger.GetBreakpointResponse: + """Post-rpc interceptor for get_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_list_breakpoints(self, request: debugger.ListBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListBreakpointsRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_breakpoints + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_list_breakpoints(self, response: debugger.ListBreakpointsResponse) -> debugger.ListBreakpointsResponse: + """Post-rpc interceptor for list_breakpoints + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_list_debuggees(self, request: debugger.ListDebuggeesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListDebuggeesRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for list_debuggees + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_list_debuggees(self, response: debugger.ListDebuggeesResponse) -> debugger.ListDebuggeesResponse: + """Post-rpc interceptor for list_debuggees + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + def pre_set_breakpoint(self, request: debugger.SetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.SetBreakpointRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for set_breakpoint + + Override in a subclass to manipulate the request or metadata + before they are sent to the Debugger2 server. + """ + return request, metadata + + def post_set_breakpoint(self, response: debugger.SetBreakpointResponse) -> debugger.SetBreakpointResponse: + """Post-rpc interceptor for set_breakpoint + + Override in a subclass to manipulate the response + after it is returned by the Debugger2 server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class Debugger2RestStub: + _session: AuthorizedSession + _host: str + _interceptor: Debugger2RestInterceptor + + +class Debugger2RestTransport(Debugger2Transport): + """REST 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 JSON representations of protocol buffers over HTTP/1.1 + + """ + + def __init__(self, *, + host: str = 'clouddebugger.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + client_cert_source_for_mtls: Optional[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, + url_scheme: str = 'https', + interceptor: Optional[Debugger2RestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> 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 ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client + certificate to configure mutual TLS HTTP channel. It is ignored + if ``channel`` 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 are developing + your own client library. + always_use_jwt_access (Optional[bool]): Whether self signed JWT should + be used for service account credentials. + url_scheme: the protocol scheme for the API endpoint. Normally + "https", but for testing or local servers, + "http" can be specified. + """ + # Run the base constructor + # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. + # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the + # credentials object + maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) + if maybe_url_match is None: + raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER + + url_match_items = maybe_url_match.groupdict() + + host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host + + super().__init__( + host=host, + credentials=credentials, + client_info=client_info, + always_use_jwt_access=always_use_jwt_access, + api_audience=api_audience + ) + self._session = AuthorizedSession( + self._credentials, default_host=self.DEFAULT_HOST) + if client_cert_source_for_mtls: + self._session.configure_mtls_channel(client_cert_source_for_mtls) + self._interceptor = interceptor or Debugger2RestInterceptor() + self._prep_wrapped_messages(client_info) + + class _DeleteBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("DeleteBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.DeleteBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the delete breakpoint method over HTTP. + + Args: + request (~.debugger.DeleteBreakpointRequest): + The request object. Request to delete a breakpoint. + 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. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'delete', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', + }, + ] + request, metadata = self._interceptor.pre_delete_breakpoint(request, metadata) + pb_request = debugger.DeleteBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + class _GetBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("GetBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.GetBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.GetBreakpointResponse: + r"""Call the get breakpoint method over HTTP. + + Args: + request (~.debugger.GetBreakpointRequest): + The request object. Request to get breakpoint + information. + 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: + ~.debugger.GetBreakpointResponse: + Response for getting breakpoint + information. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', + }, + ] + request, metadata = self._interceptor.pre_get_breakpoint(request, metadata) + pb_request = debugger.GetBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.GetBreakpointResponse() + pb_resp = debugger.GetBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_breakpoint(resp) + return resp + + class _ListBreakpoints(Debugger2RestStub): + def __hash__(self): + return hash("ListBreakpoints") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.ListBreakpointsRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.ListBreakpointsResponse: + r"""Call the list breakpoints method over HTTP. + + Args: + request (~.debugger.ListBreakpointsRequest): + The request object. Request to list breakpoints. + 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: + ~.debugger.ListBreakpointsResponse: + Response for listing breakpoints. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints', + }, + ] + request, metadata = self._interceptor.pre_list_breakpoints(request, metadata) + pb_request = debugger.ListBreakpointsRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.ListBreakpointsResponse() + pb_resp = debugger.ListBreakpointsResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_breakpoints(resp) + return resp + + class _ListDebuggees(Debugger2RestStub): + def __hash__(self): + return hash("ListDebuggees") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "project" : "", "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.ListDebuggeesRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.ListDebuggeesResponse: + r"""Call the list debuggees method over HTTP. + + Args: + request (~.debugger.ListDebuggeesRequest): + The request object. Request to list debuggees. + 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: + ~.debugger.ListDebuggeesResponse: + Response for listing debuggees. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v2/debugger/debuggees', + }, + ] + request, metadata = self._interceptor.pre_list_debuggees(request, metadata) + pb_request = debugger.ListDebuggeesRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.ListDebuggeesResponse() + pb_resp = debugger.ListDebuggeesResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_list_debuggees(resp) + return resp + + class _SetBreakpoint(Debugger2RestStub): + def __hash__(self): + return hash("SetBreakpoint") + + __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { + "breakpoint" : {}, "clientVersion" : "", } + + @classmethod + def _get_unset_required_fields(cls, message_dict): + return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} + + def __call__(self, + request: debugger.SetBreakpointRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> debugger.SetBreakpointResponse: + r"""Call the set breakpoint method over HTTP. + + Args: + request (~.debugger.SetBreakpointRequest): + The request object. Request to set a breakpoint + 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: + ~.debugger.SetBreakpointResponse: + Response for setting a breakpoint. + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/set', + 'body': 'breakpoint_', + }, + ] + request, metadata = self._interceptor.pre_set_breakpoint(request, metadata) + pb_request = debugger.SetBreakpointRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + including_default_value_fields=False, + use_integers_for_enums=True + ) + uri = transcoded_request['uri'] + method = transcoded_request['method'] + + # Jsonify the query params + query_params = json.loads(json_format.MessageToJson( + transcoded_request['query_params'], + including_default_value_fields=False, + use_integers_for_enums=True, + )) + query_params.update(self._get_unset_required_fields(query_params)) + + query_params["$alt"] = "json;enum-encoding=int" + + # Send the request + headers = dict(metadata) + headers['Content-Type'] = 'application/json' + response = getattr(self._session, method)( + "{host}{uri}".format(host=self._host, uri=uri), + timeout=timeout, + headers=headers, + params=rest_helpers.flatten_query_params(query_params, strict=True), + data=body, + ) + + # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception + # subclass. + if response.status_code >= 400: + raise core_exceptions.from_http_response(response) + + # Return the response + resp = debugger.SetBreakpointResponse() + pb_resp = debugger.SetBreakpointResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_set_breakpoint(resp) + return resp + + @property + def delete_breakpoint(self) -> Callable[ + [debugger.DeleteBreakpointRequest], + empty_pb2.Empty]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._DeleteBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_breakpoint(self) -> Callable[ + [debugger.GetBreakpointRequest], + debugger.GetBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._GetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_breakpoints(self) -> Callable[ + [debugger.ListBreakpointsRequest], + debugger.ListBreakpointsResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListBreakpoints(self._session, self._host, self._interceptor) # type: ignore + + @property + def list_debuggees(self) -> Callable[ + [debugger.ListDebuggeesRequest], + debugger.ListDebuggeesResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._ListDebuggees(self._session, self._host, self._interceptor) # type: ignore + + @property + def set_breakpoint(self) -> Callable[ + [debugger.SetBreakpointRequest], + debugger.SetBreakpointResponse]: + # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. + # In C++ this would require a dynamic_cast + return self._SetBreakpoint(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'Debugger2RestTransport', +) 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..9791b6c --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py @@ -0,0 +1,68 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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..2ed0286 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py @@ -0,0 +1,176 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +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: data.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: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + wait_token: str = proto.Field( + proto.STRING, + number=2, + ) + success_on_timeout: bool = proto.Field( + proto.BOOL, + number=3, + ) + + +class ListActiveBreakpointsResponse(proto.Message): + r"""Response for listing active breakpoints. + + Attributes: + breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + next_wait_token: str = proto.Field( + proto.STRING, + number=2, + ) + wait_expired: bool = 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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_: data.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..42e4206 --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py @@ -0,0 +1,681 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +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 (MutableSequence[str]): + Optional parameters to be embedded into the + message. + """ + + format_: str = proto.Field( + proto.STRING, + number=1, + ) + parameters: MutableSequence[str] = 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. + + Values: + UNSPECIFIED (0): + Status doesn't refer to any particular input. + BREAKPOINT_SOURCE_LOCATION (3): + Status applies to the breakpoint and is + related to its location. + BREAKPOINT_CONDITION (4): + Status applies to the breakpoint and is + related to its condition. + BREAKPOINT_EXPRESSION (7): + Status applies to the breakpoint and is + related to its expressions. + BREAKPOINT_AGE (8): + Status applies to the breakpoint and is + related to its age. + VARIABLE_NAME (5): + Status applies to the entire variable. + VARIABLE_VALUE (6): + Status applies to variable value (variable + name is valid). + """ + UNSPECIFIED = 0 + BREAKPOINT_SOURCE_LOCATION = 3 + BREAKPOINT_CONDITION = 4 + BREAKPOINT_EXPRESSION = 7 + BREAKPOINT_AGE = 8 + VARIABLE_NAME = 5 + VARIABLE_VALUE = 6 + + is_error: bool = proto.Field( + proto.BOOL, + number=1, + ) + refers_to: Reference = proto.Field( + proto.ENUM, + number=2, + enum=Reference, + ) + description: 'FormatMessage' = 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: str = proto.Field( + proto.STRING, + number=1, + ) + line: int = proto.Field( + proto.INT32, + number=2, + ) + column: int = 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 (MutableSequence[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: str = proto.Field( + proto.STRING, + number=1, + ) + value: str = proto.Field( + proto.STRING, + number=2, + ) + type_: str = proto.Field( + proto.STRING, + number=6, + ) + members: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='Variable', + ) + var_table_index: wrappers_pb2.Int32Value = proto.Field( + proto.MESSAGE, + number=4, + message=wrappers_pb2.Int32Value, + ) + status: 'StatusMessage' = 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 (MutableSequence[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_ (MutableSequence[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: str = proto.Field( + proto.STRING, + number=1, + ) + location: 'SourceLocation' = proto.Field( + proto.MESSAGE, + number=2, + message='SourceLocation', + ) + arguments: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=3, + message='Variable', + ) + locals_: MutableSequence['Variable'] = 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 (MutableSequence[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 (MutableSequence[google.cloud.debugger_v2.types.StackFrame]): + The stack at breakpoint time, where stack_frames[0] + represents the most recently entered function. + evaluated_expressions (MutableSequence[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 (MutableSequence[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 (MutableMapping[str, str]): + 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. + + Values: + CAPTURE (0): + Capture stack frame and variables and update + the breakpoint. The data is only captured once. + After that the breakpoint is set in a final + state. + LOG (1): + Log each breakpoint hit. The breakpoint + remains active until deleted or expired. + """ + CAPTURE = 0 + LOG = 1 + + class LogLevel(proto.Enum): + r"""Log severity levels. + + Values: + INFO (0): + Information log message. + WARNING (1): + Warning log message. + ERROR (2): + Error log message. + """ + INFO = 0 + WARNING = 1 + ERROR = 2 + + id: str = proto.Field( + proto.STRING, + number=1, + ) + action: Action = proto.Field( + proto.ENUM, + number=13, + enum=Action, + ) + location: 'SourceLocation' = proto.Field( + proto.MESSAGE, + number=2, + message='SourceLocation', + ) + condition: str = proto.Field( + proto.STRING, + number=3, + ) + expressions: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=4, + ) + log_message_format: str = proto.Field( + proto.STRING, + number=14, + ) + log_level: LogLevel = proto.Field( + proto.ENUM, + number=15, + enum=LogLevel, + ) + is_final_state: bool = proto.Field( + proto.BOOL, + number=5, + ) + create_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=11, + message=timestamp_pb2.Timestamp, + ) + final_time: timestamp_pb2.Timestamp = proto.Field( + proto.MESSAGE, + number=12, + message=timestamp_pb2.Timestamp, + ) + user_email: str = proto.Field( + proto.STRING, + number=16, + ) + status: 'StatusMessage' = proto.Field( + proto.MESSAGE, + number=10, + message='StatusMessage', + ) + stack_frames: MutableSequence['StackFrame'] = proto.RepeatedField( + proto.MESSAGE, + number=7, + message='StackFrame', + ) + evaluated_expressions: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=8, + message='Variable', + ) + variable_table: MutableSequence['Variable'] = proto.RepeatedField( + proto.MESSAGE, + number=9, + message='Variable', + ) + labels: MutableMapping[str, str] = 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 (MutableSequence[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 (MutableSequence[google.devtools.source.v1.source_context_pb2.ExtendedSourceContext]): + References to the locations and revisions of + the source code used in the deployed + application. + labels (MutableMapping[str, str]): + A set of custom debuggee properties, + populated by the agent, to be displayed to the + user. + """ + + id: str = proto.Field( + proto.STRING, + number=1, + ) + project: str = proto.Field( + proto.STRING, + number=2, + ) + uniquifier: str = proto.Field( + proto.STRING, + number=3, + ) + description: str = proto.Field( + proto.STRING, + number=4, + ) + is_inactive: bool = proto.Field( + proto.BOOL, + number=5, + ) + agent_version: str = proto.Field( + proto.STRING, + number=6, + ) + is_disabled: bool = proto.Field( + proto.BOOL, + number=7, + ) + status: 'StatusMessage' = proto.Field( + proto.MESSAGE, + number=8, + message='StatusMessage', + ) + source_contexts: MutableSequence[source_context_pb2.SourceContext] = proto.RepeatedField( + proto.MESSAGE, + number=9, + message=source_context_pb2.SourceContext, + ) + ext_source_contexts: MutableSequence[source_context_pb2.ExtendedSourceContext] = proto.RepeatedField( + proto.MESSAGE, + number=13, + message=source_context_pb2.ExtendedSourceContext, + ) + labels: MutableMapping[str, str] = 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..0c2fa0a --- /dev/null +++ b/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py @@ -0,0 +1,315 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 __future__ import annotations + +from typing import MutableMapping, MutableSequence + +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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_: data.Breakpoint = proto.Field( + proto.MESSAGE, + number=2, + message=data.Breakpoint, + ) + client_version: str = 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_: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_id: str = proto.Field( + proto.STRING, + number=2, + ) + client_version: str = 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_: data.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: str = proto.Field( + proto.STRING, + number=1, + ) + breakpoint_id: str = proto.Field( + proto.STRING, + number=2, + ) + client_version: str = 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: data.Breakpoint.Action = proto.Field( + proto.ENUM, + number=1, + enum=data.Breakpoint.Action, + ) + + debuggee_id: str = proto.Field( + proto.STRING, + number=1, + ) + include_all_users: bool = proto.Field( + proto.BOOL, + number=2, + ) + include_inactive: bool = proto.Field( + proto.BOOL, + number=3, + ) + action: BreakpointActionValue = proto.Field( + proto.MESSAGE, + number=4, + message=BreakpointActionValue, + ) + strip_results: bool = proto.Field( + proto.BOOL, + number=5, + ) + wait_token: str = proto.Field( + proto.STRING, + number=6, + ) + client_version: str = proto.Field( + proto.STRING, + number=8, + ) + + +class ListBreakpointsResponse(proto.Message): + r"""Response for listing breakpoints. + + Attributes: + breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( + proto.MESSAGE, + number=1, + message=data.Breakpoint, + ) + next_wait_token: str = 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: str = proto.Field( + proto.STRING, + number=2, + ) + include_inactive: bool = proto.Field( + proto.BOOL, + number=3, + ) + client_version: str = proto.Field( + proto.STRING, + number=4, + ) + + +class ListDebuggeesResponse(proto.Message): + r"""Response for listing debuggees. + + Attributes: + debuggees (MutableSequence[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: MutableSequence[data.Debuggee] = 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..574c5ae --- /dev/null +++ b/owl-bot-staging/v2/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +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..02ef930 --- /dev/null +++ b/owl-bot-staging/v2/noxfile.py @@ -0,0 +1,184 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", +] + +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") + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.11" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "lint_setup_py", +] + +@nox.session(python=ALL_PYTHON) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/debugger_v2/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +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=ALL_PYTHON) +def mypy(session): + """Run the type checker.""" + session.install( + 'mypy', + 'types-requests', + 'types-protobuf' + ) + 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=DEFAULT_PYTHON_VERSION) +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", ""), + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint(session): + """Run linters. + + Returns a failure if the linters find linting errors or sufficiently + serious code quality issues. + """ + session.install("flake8", BLACK_VERSION) + session.run( + "black", + "--check", + *BLACK_PATHS, + ) + session.run("flake8", "google", "tests", "samples") + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def blacken(session): + """Run black. Format code to uniform standard.""" + session.install(BLACK_VERSION) + session.run( + "black", + *BLACK_PATHS, + ) + + +@nox.session(python=DEFAULT_PYTHON_VERSION) +def lint_setup_py(session): + """Verify that setup.py is valid (including RST check).""" + session.install("docutils", "pygments") + session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py new file mode 100644 index 0000000..24f6ea0 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListActiveBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py new file mode 100644 index 0000000..67c27c7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListActiveBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_active_breakpoints(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.ListActiveBreakpointsRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.list_active_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py new file mode 100644 index 0000000..b0ac801 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDebuggee +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = await client.register_debuggee(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py new file mode 100644 index 0000000..99f6287 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py @@ -0,0 +1,51 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for RegisterDebuggee +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_register_debuggee(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.RegisterDebuggeeRequest( + ) + + # Make the request + response = client.register_debuggee(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py new file mode 100644 index 0000000..e74e3e7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateActiveBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = await client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py new file mode 100644 index 0000000..10a9948 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for UpdateActiveBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_update_active_breakpoint(): + # Create a client + client = debugger_v2.Controller2Client() + + # Initialize request argument(s) + request = debugger_v2.UpdateActiveBreakpointRequest( + debuggee_id="debuggee_id_value", + ) + + # Make the request + response = client.update_active_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py new file mode 100644 index 0000000..b445c89 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + await client.delete_breakpoint(request=request) + + +# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py new file mode 100644 index 0000000..01599f2 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for DeleteBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_delete_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.DeleteBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + client.delete_breakpoint(request=request) + + +# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py new file mode 100644 index 0000000..7074dcf --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.get_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py new file mode 100644 index 0000000..3f7ebd0 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py @@ -0,0 +1,54 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for GetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_get_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.GetBreakpointRequest( + debuggee_id="debuggee_id_value", + breakpoint_id="breakpoint_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.get_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py new file mode 100644 index 0000000..816dd2b --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py new file mode 100644 index 0000000..4f65108 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListBreakpoints +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_breakpoints(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListBreakpointsRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_breakpoints(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py new file mode 100644 index 0000000..fda422c --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListDebuggees +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.list_debuggees(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py new file mode 100644 index 0000000..246e83f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for ListDebuggees +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_list_debuggees(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.ListDebuggeesRequest( + project="project_value", + client_version="client_version_value", + ) + + # Make the request + response = client.list_debuggees(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py new file mode 100644 index 0000000..6267555 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +async def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2AsyncClient() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = await client.set_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py new file mode 100644 index 0000000..22b41d7 --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py @@ -0,0 +1,53 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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. +# +# Generated code. DO NOT EDIT! +# +# Snippet for SetBreakpoint +# NOTE: This snippet has been automatically generated for illustrative purposes only. +# It may require modifications to work in your environment. + +# To install the latest published package dependency, execute the following: +# python3 -m pip install google-cloud-debugger-client + + +# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] +# This snippet has been automatically generated and should be regarded as a +# code template only. +# It will require modifications to work: +# - It may require correct/in-range values for request initialization. +# - It may require specifying regional endpoints when creating the service +# client as shown in: +# https://googleapis.dev/python/google-api-core/latest/client_options.html +from google.cloud import debugger_v2 + + +def sample_set_breakpoint(): + # Create a client + client = debugger_v2.Debugger2Client() + + # Initialize request argument(s) + request = debugger_v2.SetBreakpointRequest( + debuggee_id="debuggee_id_value", + client_version="client_version_value", + ) + + # Make the request + response = client.set_breakpoint(request=request) + + # Handle the response + print(response) + +# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json new file mode 100644 index 0000000..ab6c88f --- /dev/null +++ b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json @@ -0,0 +1,1369 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.devtools.clouddebugger.v2", + "version": "v2" + } + ], + "language": "PYTHON", + "name": "google-cloud-debugger-client", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.list_active_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "ListActiveBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", + "shortName": "list_active_breakpoints" + }, + "description": "Sample for ListActiveBreakpoints", + "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.list_active_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "ListActiveBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", + "shortName": "list_active_breakpoints" + }, + "description": "Sample for ListActiveBreakpoints", + "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.register_debuggee", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "RegisterDebuggee" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" + }, + { + "name": "debuggee", + "type": "google.cloud.debugger_v2.types.Debuggee" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", + "shortName": "register_debuggee" + }, + "description": "Sample for RegisterDebuggee", + "file": "clouddebugger_v2_generated_controller2_register_debuggee_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_async", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_register_debuggee_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.register_debuggee", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "RegisterDebuggee" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" + }, + { + "name": "debuggee", + "type": "google.cloud.debugger_v2.types.Debuggee" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", + "shortName": "register_debuggee" + }, + "description": "Sample for RegisterDebuggee", + "file": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync", + "segments": [ + { + "end": 50, + "start": 27, + "type": "FULL" + }, + { + "end": 50, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 44, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 47, + "start": 45, + "type": "REQUEST_EXECUTION" + }, + { + "end": 51, + "start": 48, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", + "shortName": "Controller2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.update_active_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "UpdateActiveBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", + "shortName": "update_active_breakpoint" + }, + "description": "Sample for UpdateActiveBreakpoint", + "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Controller2Client", + "shortName": "Controller2Client" + }, + "fullName": "google.cloud.debugger_v2.Controller2Client.update_active_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Controller2", + "shortName": "Controller2" + }, + "shortName": "UpdateActiveBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", + "shortName": "update_active_breakpoint" + }, + "description": "Sample for UpdateActiveBreakpoint", + "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 48, + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "start": 49, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.delete_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "DeleteBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_breakpoint" + }, + "description": "Sample for DeleteBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.delete_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "DeleteBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_breakpoint" + }, + "description": "Sample for DeleteBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync", + "segments": [ + { + "end": 51, + "start": 27, + "type": "FULL" + }, + { + "end": 51, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 52, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.get_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "GetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", + "shortName": "get_breakpoint" + }, + "description": "Sample for GetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_async", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.get_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "GetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", + "shortName": "get_breakpoint" + }, + "description": "Sample for GetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync", + "segments": [ + { + "end": 53, + "start": 27, + "type": "FULL" + }, + { + "end": 53, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 47, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 50, + "start": 48, + "type": "REQUEST_EXECUTION" + }, + { + "end": 54, + "start": 51, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", + "shortName": "list_breakpoints" + }, + "description": "Sample for ListBreakpoints", + "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.list_breakpoints", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListBreakpoints" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", + "shortName": "list_breakpoints" + }, + "description": "Sample for ListBreakpoints", + "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_debuggees", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListDebuggees" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" + }, + { + "name": "project", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", + "shortName": "list_debuggees" + }, + "description": "Sample for ListDebuggees", + "file": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.list_debuggees", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "ListDebuggees" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" + }, + { + "name": "project", + "type": "str" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", + "shortName": "list_debuggees" + }, + "description": "Sample for ListDebuggees", + "file": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", + "shortName": "Debugger2AsyncClient" + }, + "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.set_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "SetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", + "shortName": "set_breakpoint" + }, + "description": "Sample for SetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_async", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.debugger_v2.Debugger2Client", + "shortName": "Debugger2Client" + }, + "fullName": "google.cloud.debugger_v2.Debugger2Client.set_breakpoint", + "method": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", + "service": { + "fullName": "google.devtools.clouddebugger.v2.Debugger2", + "shortName": "Debugger2" + }, + "shortName": "SetBreakpoint" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" + }, + { + "name": "debuggee_id", + "type": "str" + }, + { + "name": "breakpoint_", + "type": "google.cloud.debugger_v2.types.Breakpoint" + }, + { + "name": "client_version", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", + "shortName": "set_breakpoint" + }, + "description": "Sample for SetBreakpoint", + "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync", + "segments": [ + { + "end": 52, + "start": 27, + "type": "FULL" + }, + { + "end": 52, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 46, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "end": 49, + "start": 47, + "type": "REQUEST_EXECUTION" + }, + { + "end": 53, + "start": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py" + } + ] +} 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..9802c14 --- /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 2022 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..4295418 --- /dev/null +++ b/owl-bot-staging/v2/setup.py @@ -0,0 +1,90 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-debugger-client' + + +description = "Google Cloud Debugger Client API client library" + +version = {} +with open(os.path.join(package_root, 'google/cloud/debugger/gapic_version.py')) as fp: + exec(fp.read(), version) +version = version["__version__"] + +if version[0] == "0": + release_status = "Development Status :: 4 - Beta" +else: + release_status = "Development Status :: 5 - Production/Stable" + +dependencies = [ + "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", + "proto-plus >= 1.22.0, <2.0.0dev", + "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", + "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", +] +url = "https://github.com/googleapis/python-debugger-client" + +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() + +packages = [ + package + for package in setuptools.PEP420PackageFinder.find() + if package.startswith("google") +] + +namespaces = ["google", "google.cloud"] + +setuptools.setup( + name=name, + version=version, + description=description, + long_description=readme, + author="Google LLC", + author_email="googleapis-packages@google.com", + license="Apache 2.0", + url=url, + classifiers=[ + release_status, + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + namespace_packages=namespaces, + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/v2/testing/constraints-3.10.txt b/owl-bot-staging/v2/testing/constraints-3.10.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.10.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.11.txt b/owl-bot-staging/v2/testing/constraints-3.11.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.11.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.12.txt b/owl-bot-staging/v2/testing/constraints-3.12.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.12.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.7.txt b/owl-bot-staging/v2/testing/constraints-3.7.txt new file mode 100644 index 0000000..6c44adf --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.7.txt @@ -0,0 +1,9 @@ +# This constraints file is used to check that lower bounds +# are correct in setup.py +# List all library dependencies and extras in this file. +# Pin the version to the lower bound. +# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", +# Then this file should have google-cloud-foo==1.14.0 +google-api-core==1.34.0 +proto-plus==1.22.0 +protobuf==3.19.5 diff --git a/owl-bot-staging/v2/testing/constraints-3.8.txt b/owl-bot-staging/v2/testing/constraints-3.8.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.8.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.9.txt b/owl-bot-staging/v2/testing/constraints-3.9.txt new file mode 100644 index 0000000..ed7f9ae --- /dev/null +++ b/owl-bot-staging/v2/testing/constraints-3.9.txt @@ -0,0 +1,6 @@ +# -*- coding: utf-8 -*- +# This constraints file is required for unit tests. +# List all library dependencies and extras in this file. +google-api-core +proto-plus +protobuf diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py new file mode 100644 index 0000000..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..231bc12 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2022 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..5058381 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py @@ -0,0 +1,2551 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +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,transport_name", [ + (Controller2Client, "grpc"), + (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), +]) +def test_controller2_client_from_service_account_info(client_class, transport_name): + 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, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.Controller2GrpcTransport, "grpc"), + (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Controller2RestTransport, "rest"), +]) +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,transport_name", [ + (Controller2Client, "grpc"), + (Controller2AsyncClient, "grpc_asyncio"), + (Controller2Client, "rest"), +]) +def test_controller2_client_from_service_account_file(client_class, transport_name): + 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", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +def test_controller2_client_get_transport_class(): + transport = Controller2Client.get_transport_class() + available_transports = [ + transports.Controller2GrpcTransport, + transports.Controller2RestTransport, + ] + 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"), + (Controller2Client, transports.Controller2RestTransport, "rest"), +]) +@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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + 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=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@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"), + (Controller2Client, transports.Controller2RestTransport, "rest", "true"), + (Controller2Client, transports.Controller2RestTransport, "rest", "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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + +@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"), + (Controller2Client, transports.Controller2RestTransport, "rest"), +]) +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, + api_audience=None, + ) + +@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), + (Controller2Client, transports.Controller2RestTransport, "rest", None), +]) +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, + api_audience=None, + ) + +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, + api_audience=None, + ) + + +@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, + api_audience=None, + ) + + # 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_field_headers(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.ListActiveBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # 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: + call.return_value = controller.ListActiveBreakpointsResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_active_breakpoints_field_headers_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.ListActiveBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # 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: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.UpdateActiveBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint.id = 'id_value' + + # 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: + call.return_value = controller.UpdateActiveBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_active_breakpoint_field_headers_async(): + client = Controller2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = controller.UpdateActiveBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint.id = 'id_value' + + # 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: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', + ) in kw['metadata'] + + +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'), + ) + + +@pytest.mark.parametrize("request_type", [ + controller.RegisterDebuggeeRequest, + dict, +]) +def test_register_debuggee_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.register_debuggee(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.RegisterDebuggeeResponse) + + +def test_register_debuggee_rest_required_fields(request_type=controller.RegisterDebuggeeRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.register_debuggee(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_register_debuggee_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.register_debuggee._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("debuggee", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_register_debuggee_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_register_debuggee") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_register_debuggee") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.RegisterDebuggeeRequest.pb(controller.RegisterDebuggeeRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.RegisterDebuggeeResponse.to_json(controller.RegisterDebuggeeResponse()) + + request = controller.RegisterDebuggeeRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.RegisterDebuggeeResponse() + + client.register_debuggee(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_register_debuggee_rest_bad_request(transport: str = 'rest', request_type=controller.RegisterDebuggeeRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.register_debuggee(request) + + +def test_register_debuggee_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.RegisterDebuggeeResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + debuggee=data.Debuggee(id='id_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.register_debuggee(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/register" % client.transport._host, args[1]) + + +def test_register_debuggee_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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'), + ) + + +def test_register_debuggee_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + controller.ListActiveBreakpointsRequest, + dict, +]) +def test_list_active_breakpoints_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse( + next_wait_token='next_wait_token_value', + wait_expired=True, + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_active_breakpoints(request) + + # 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_rest_required_fields(request_type=controller.ListActiveBreakpointsRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("success_on_timeout", "wait_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_active_breakpoints(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_active_breakpoints_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_active_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == (set(("successOnTimeout", "waitToken", )) & set(("debuggeeId", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_active_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_list_active_breakpoints") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_list_active_breakpoints") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.ListActiveBreakpointsRequest.pb(controller.ListActiveBreakpointsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.ListActiveBreakpointsResponse.to_json(controller.ListActiveBreakpointsResponse()) + + request = controller.ListActiveBreakpointsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.ListActiveBreakpointsResponse() + + client.list_active_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_active_breakpoints_rest_bad_request(transport: str = 'rest', request_type=controller.ListActiveBreakpointsRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_active_breakpoints(request) + + +def test_list_active_breakpoints_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.ListActiveBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_active_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) + + +def test_list_active_breakpoints_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_active_breakpoints_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + controller.UpdateActiveBreakpointRequest, + dict, +]) +def test_update_active_breakpoint_rest(request_type): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_active_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, controller.UpdateActiveBreakpointResponse) + + +def test_update_active_breakpoint_rest_required_fields(request_type=controller.UpdateActiveBreakpointRequest): + transport_class = transports.Controller2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "put", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_active_breakpoint(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_active_breakpoint_rest_unset_required_fields(): + transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_active_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("debuggeeId", "breakpoint", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_active_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Controller2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), + ) + client = Controller2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Controller2RestInterceptor, "post_update_active_breakpoint") as post, \ + mock.patch.object(transports.Controller2RestInterceptor, "pre_update_active_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = controller.UpdateActiveBreakpointRequest.pb(controller.UpdateActiveBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = controller.UpdateActiveBreakpointResponse.to_json(controller.UpdateActiveBreakpointResponse()) + + request = controller.UpdateActiveBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = controller.UpdateActiveBreakpointResponse() + + client.update_active_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_active_breakpoint_rest_bad_request(transport: str = 'rest', request_type=controller.UpdateActiveBreakpointRequest): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.update_active_breakpoint(request) + + +def test_update_active_breakpoint_rest_flattened(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = controller.UpdateActiveBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_active_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}" % client.transport._host, args[1]) + + +def test_update_active_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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'), + ) + + +def test_update_active_breakpoint_rest_error(): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +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, + transports.Controller2RestTransport, +]) +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() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = Controller2Client.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +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() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +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", + [ + transports.Controller2GrpcTransport, + transports.Controller2GrpcAsyncIOTransport, + transports.Controller2RestTransport, + ], +) +def test_controller2_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@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_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.Controller2RestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_controller2_host_no_port(transport_name): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_controller2_host_with_port(transport_name): + client = Controller2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_controller2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Controller2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Controller2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.register_debuggee._session + session2 = client2.transport.register_debuggee._session + assert session1 != session2 + session1 = client1.transport.list_active_breakpoints._session + session2 = client2.transport.list_active_breakpoints._session + assert session1 != session2 + session1 = client1.transport.update_active_breakpoint._session + session2 = client2.transport.update_active_breakpoint._session + assert session1 != session2 +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 = { + "rest": "_session", + "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 = [ + 'rest', + '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, + api_audience=None, + ) 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..ad07b63 --- /dev/null +++ b/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py @@ -0,0 +1,3628 @@ +# -*- coding: utf-8 -*- +# Copyright 2022 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 +# try/except added for compatibility with python < 3.8 +try: + from unittest import mock + from unittest.mock import AsyncMock # pragma: NO COVER +except ImportError: # pragma: NO COVER + import mock + +import grpc +from grpc.experimental import aio +from collections.abc import Iterable +from google.protobuf import json_format +import json +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule +from proto.marshal.rules import wrappers +from requests import Response +from requests import Request, PreparedRequest +from requests.sessions import Session +from google.protobuf import json_format + +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,transport_name", [ + (Debugger2Client, "grpc"), + (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), +]) +def test_debugger2_client_from_service_account_info(client_class, transport_name): + 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, transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.Debugger2GrpcTransport, "grpc"), + (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), + (transports.Debugger2RestTransport, "rest"), +]) +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,transport_name", [ + (Debugger2Client, "grpc"), + (Debugger2AsyncClient, "grpc_asyncio"), + (Debugger2Client, "rest"), +]) +def test_debugger2_client_from_service_account_file(client_class, transport_name): + 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", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://clouddebugger.googleapis.com' + ) + + +def test_debugger2_client_get_transport_class(): + transport = Debugger2Client.get_transport_class() + available_transports = [ + transports.Debugger2GrpcTransport, + transports.Debugger2RestTransport, + ] + 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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), +]) +@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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + # Check the case api_endpoint is provided + options = client_options.ClientOptions(api_audience="https://language.googleapis.com") + 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=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + always_use_jwt_access=True, + api_audience="https://language.googleapis.com" + ) + +@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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "true"), + (Debugger2Client, transports.Debugger2RestTransport, "rest", "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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + # 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, + api_audience=None, + ) + + +@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"), + (Debugger2Client, transports.Debugger2RestTransport, "rest"), +]) +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, + api_audience=None, + ) + +@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), + (Debugger2Client, transports.Debugger2RestTransport, "rest", None), +]) +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, + api_audience=None, + ) + +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, + api_audience=None, + ) + + +@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, + api_audience=None, + ) + + # 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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.SetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + call.return_value = debugger.SetBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_set_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.SetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.set_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.GetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + call.return_value = debugger.GetBreakpointResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.GetBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.DeleteBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + call.return_value = None + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_breakpoint_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.DeleteBreakpointRequest() + + request.debuggee_id = 'debuggee_id_value' + request.breakpoint_id = 'breakpoint_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_breakpoint), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', + ) in kw['metadata'] + + +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_field_headers(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.ListBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + call.return_value = debugger.ListBreakpointsResponse() + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_list_breakpoints_field_headers_async(): + client = Debugger2AsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Any value that is part of the HTTP/1.1 URI should be sent as + # a field header. Set these to a non-empty value. + request = debugger.ListBreakpointsRequest() + + request.debuggee_id = 'debuggee_id_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.list_breakpoints), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse()) + 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] == request + + # Establish that the field header was sent. + _, _, kw = call.mock_calls[0] + assert ( + 'x-goog-request-params', + 'debuggee_id=debuggee_id_value', + ) in kw['metadata'] + + +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', + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.SetBreakpointRequest, + dict, +]) +def test_set_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.set_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.SetBreakpointResponse) + + +def test_set_breakpoint_rest_required_fields(request_type=debugger.SetBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("breakpoint_", "client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "post", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.set_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_set_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.set_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("breakpoint", "clientVersion", )) & set(("debuggeeId", "breakpoint", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_set_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_set_breakpoint") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_set_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.SetBreakpointRequest.pb(debugger.SetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.SetBreakpointResponse.to_json(debugger.SetBreakpointResponse()) + + request = debugger.SetBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.SetBreakpointResponse() + + client.set_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_set_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.SetBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.set_breakpoint(request) + + +def test_set_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.SetBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_=data.Breakpoint(id='id_value'), + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.SetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.set_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/set" % client.transport._host, args[1]) + + +def test_set_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_set_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.GetBreakpointRequest, + dict, +]) +def test_get_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_breakpoint(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.GetBreakpointResponse) + + +def test_get_breakpoint_rest_required_fields(request_type=debugger.GetBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["breakpointId"] = 'breakpoint_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == 'breakpoint_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_get_breakpoint") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_get_breakpoint") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.GetBreakpointRequest.pb(debugger.GetBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.GetBreakpointResponse.to_json(debugger.GetBreakpointResponse()) + + request = debugger.GetBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.GetBreakpointResponse() + + client.get_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.GetBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.get_breakpoint(request) + + +def test_get_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.GetBreakpointResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.GetBreakpointResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) + + +def test_get_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_get_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.DeleteBreakpointRequest, + dict, +]) +def test_delete_breakpoint_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.delete_breakpoint(request) + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_breakpoint_rest_required_fields(request_type=debugger.DeleteBreakpointRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["breakpoint_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["breakpointId"] = 'breakpoint_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "breakpointId" in jsonified_request + assert jsonified_request["breakpointId"] == 'breakpoint_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = None + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "delete", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.delete_breakpoint(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_breakpoint_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_breakpoint._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_breakpoint_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_delete_breakpoint") as pre: + pre.assert_not_called() + pb_message = debugger.DeleteBreakpointRequest.pb(debugger.DeleteBreakpointRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + + request = debugger.DeleteBreakpointRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_delete_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.DeleteBreakpointRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.delete_breakpoint(request) + + +def test_delete_breakpoint_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = None + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + breakpoint_id='breakpoint_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + json_return_value = '' + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.delete_breakpoint(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) + + +def test_delete_breakpoint_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_delete_breakpoint_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.ListBreakpointsRequest, + dict, +]) +def test_list_breakpoints_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse( + next_wait_token='next_wait_token_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_breakpoints(request) + + # 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_rest_required_fields(request_type=debugger.ListBreakpointsRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["debuggee_id"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["debuggeeId"] = 'debuggee_id_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("action", "client_version", "include_all_users", "include_inactive", "strip_results", "wait_token", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "debuggeeId" in jsonified_request + assert jsonified_request["debuggeeId"] == 'debuggee_id_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_breakpoints(request) + + expected_params = [ + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_breakpoints_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_breakpoints._get_unset_required_fields({}) + assert set(unset_fields) == (set(("action", "clientVersion", "includeAllUsers", "includeInactive", "stripResults", "waitToken", )) & set(("debuggeeId", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_breakpoints_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_list_breakpoints") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_breakpoints") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListBreakpointsRequest.pb(debugger.ListBreakpointsRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListBreakpointsResponse.to_json(debugger.ListBreakpointsResponse()) + + request = debugger.ListBreakpointsRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListBreakpointsResponse() + + client.list_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_breakpoints_rest_bad_request(transport: str = 'rest', request_type=debugger.ListBreakpointsRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'debuggee_id': 'sample1'} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_breakpoints(request) + + +def test_list_breakpoints_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListBreakpointsResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'debuggee_id': 'sample1'} + + # get truthy value for each flattened field + mock_args = dict( + debuggee_id='debuggee_id_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_breakpoints(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) + + +def test_list_breakpoints_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_breakpoints_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + debugger.ListDebuggeesRequest, + dict, +]) +def test_list_debuggees_rest(request_type): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse( + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.list_debuggees(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, debugger.ListDebuggeesResponse) + + +def test_list_debuggees_rest_required_fields(request_type=debugger.ListDebuggeesRequest): + transport_class = transports.Debugger2RestTransport + + request_init = {} + request_init["project"] = "" + request_init["client_version"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + including_default_value_fields=False, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + assert "project" not in jsonified_request + assert "clientVersion" not in jsonified_request + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + assert "project" in jsonified_request + assert jsonified_request["project"] == request_init["project"] + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == request_init["client_version"] + + jsonified_request["project"] = 'project_value' + jsonified_request["clientVersion"] = 'client_version_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("client_version", "include_inactive", "project", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "project" in jsonified_request + assert jsonified_request["project"] == 'project_value' + assert "clientVersion" in jsonified_request + assert jsonified_request["clientVersion"] == 'client_version_value' + + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + # Mock the http request call within the method and fake a response. + with mock.patch.object(Session, 'request') as req: + # We need to mock transcode() because providing default values + # for required fields will fail the real version if the http_options + # expect actual values for those fields. + with mock.patch.object(path_template, 'transcode') as transcode: + # A uri without fields and an empty body will force all the + # request fields to show up in the query_params. + pb_request = request_type.pb(request) + transcode_result = { + 'uri': 'v1/sample_method', + 'method': "get", + 'query_params': pb_request, + } + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.list_debuggees(request) + + expected_params = [ + ( + "project", + "", + ), + ( + "clientVersion", + "", + ), + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_list_debuggees_rest_unset_required_fields(): + transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.list_debuggees._get_unset_required_fields({}) + assert set(unset_fields) == (set(("clientVersion", "includeInactive", "project", )) & set(("project", "clientVersion", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_list_debuggees_rest_interceptors(null_interceptor): + transport = transports.Debugger2RestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), + ) + client = Debugger2Client(transport=transport) + with mock.patch.object(type(client.transport._session), "request") as req, \ + mock.patch.object(path_template, "transcode") as transcode, \ + mock.patch.object(transports.Debugger2RestInterceptor, "post_list_debuggees") as post, \ + mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_debuggees") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = debugger.ListDebuggeesRequest.pb(debugger.ListDebuggeesRequest()) + transcode.return_value = { + "method": "post", + "uri": "my_uri", + "body": pb_message, + "query_params": pb_message, + } + + req.return_value = Response() + req.return_value.status_code = 200 + req.return_value.request = PreparedRequest() + req.return_value._content = debugger.ListDebuggeesResponse.to_json(debugger.ListDebuggeesResponse()) + + request = debugger.ListDebuggeesRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = debugger.ListDebuggeesResponse() + + client.list_debuggees(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_list_debuggees_rest_bad_request(transport: str = 'rest', request_type=debugger.ListDebuggeesRequest): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {} + request = request_type(**request_init) + + # Mock the http request call within the method and fake a BadRequest error. + with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 400 + response_value.request = Request() + req.return_value = response_value + client.list_debuggees(request) + + +def test_list_debuggees_rest_flattened(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Mock the http request call within the method and fake a response. + with mock.patch.object(type(client.transport._session), 'request') as req: + # Designate an appropriate value for the returned response. + return_value = debugger.ListDebuggeesResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {} + + # get truthy value for each flattened field + mock_args = dict( + project='project_value', + client_version='client_version_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) + json_return_value = json_format.MessageToJson(pb_return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.list_debuggees(**mock_args) + + # Establish that the underlying call was made with the expected + # request object values. + assert len(req.mock_calls) == 1 + _, args, _ = req.mock_calls[0] + assert path_template.validate("%s/v2/debugger/debuggees" % client.transport._host, args[1]) + + +def test_list_debuggees_rest_flattened_error(transport: str = 'rest'): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # 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', + ) + + +def test_list_debuggees_rest_error(): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +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, + transports.Debugger2RestTransport, +]) +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() + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "rest", +]) +def test_transport_kind(transport_name): + transport = Debugger2Client.get_transport_class(transport_name)( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert transport.kind == transport_name + +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() + + # Catch all for all remaining methods and properties + remainder = [ + 'kind', + ] + for r in remainder: + with pytest.raises(NotImplementedError): + getattr(transport, r)() + + +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", + [ + transports.Debugger2GrpcTransport, + transports.Debugger2GrpcAsyncIOTransport, + transports.Debugger2RestTransport, + ], +) +def test_debugger2_transport_auth_gdch_credentials(transport_class): + host = 'https://language.com' + api_audience_tests = [None, 'https://language2.com'] + api_audience_expect = [host, 'https://language2.com'] + for t, e in zip(api_audience_tests, api_audience_expect): + with mock.patch.object(google.auth, 'default', autospec=True) as adc: + gdch_mock = mock.MagicMock() + type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) + adc.return_value = (gdch_mock, None) + transport_class(host=host, api_audience=t) + gdch_mock.with_gdch_audience.assert_called_once_with( + e + ) + + +@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_http_transport_client_cert_source_for_mtls(): + cred = ga_credentials.AnonymousCredentials() + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: + transports.Debugger2RestTransport ( + credentials=cred, + client_cert_source_for_mtls=client_cert_source_callback + ) + mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) + + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_debugger2_host_no_port(transport_name): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_debugger2_host_with_port(transport_name): + client = Debugger2Client( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'clouddebugger.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://clouddebugger.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_debugger2_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = Debugger2Client( + credentials=creds1, + transport=transport_name, + ) + client2 = Debugger2Client( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.set_breakpoint._session + session2 = client2.transport.set_breakpoint._session + assert session1 != session2 + session1 = client1.transport.get_breakpoint._session + session2 = client2.transport.get_breakpoint._session + assert session1 != session2 + session1 = client1.transport.delete_breakpoint._session + session2 = client2.transport.delete_breakpoint._session + assert session1 != session2 + session1 = client1.transport.list_breakpoints._session + session2 = client2.transport.list_breakpoints._session + assert session1 != session2 + session1 = client1.transport.list_debuggees._session + session2 = client2.transport.list_debuggees._session + assert session1 != session2 +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 = { + "rest": "_session", + "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 = [ + 'rest', + '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, + api_audience=None, + ) From 9f665c45a490263a7a0c677a47f3e22181b8587c Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Wed, 5 Jul 2023 22:51:38 +0000 Subject: [PATCH 10/10] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20?= =?UTF-8?q?post-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- .../services/debugger2/transports/rest.py | 2 +- owl-bot-staging/v2/.coveragerc | 13 - owl-bot-staging/v2/.flake8 | 33 - 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 | 6 - owl-bot-staging/v2/docs/index.rst | 7 - .../v2/google/cloud/debugger/__init__.py | 75 - .../v2/google/cloud/debugger/gapic_version.py | 16 - .../v2/google/cloud/debugger/py.typed | 2 - .../v2/google/cloud/debugger_v2/__init__.py | 76 - .../cloud/debugger_v2/gapic_metadata.json | 167 - .../google/cloud/debugger_v2/gapic_version.py | 16 - .../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 | 566 --- .../services/controller2/client.py | 747 ---- .../controller2/transports/__init__.py | 38 - .../services/controller2/transports/base.py | 191 - .../services/controller2/transports/grpc.py | 369 -- .../controller2/transports/grpc_asyncio.py | 368 -- .../services/controller2/transports/rest.py | 553 --- .../services/debugger2/__init__.py | 22 - .../services/debugger2/async_client.py | 806 ---- .../debugger_v2/services/debugger2/client.py | 973 ----- .../services/debugger2/transports/__init__.py | 38 - .../services/debugger2/transports/base.py | 234 -- .../services/debugger2/transports/grpc.py | 381 -- .../debugger2/transports/grpc_asyncio.py | 380 -- .../services/debugger2/transports/rest.py | 729 ---- .../cloud/debugger_v2/types/__init__.py | 68 - .../cloud/debugger_v2/types/controller.py | 176 - .../v2/google/cloud/debugger_v2/types/data.py | 681 ---- .../cloud/debugger_v2/types/debugger.py | 315 -- owl-bot-staging/v2/mypy.ini | 3 - owl-bot-staging/v2/noxfile.py | 184 - ...ntroller2_list_active_breakpoints_async.py | 52 - ...ontroller2_list_active_breakpoints_sync.py | 52 - ...ted_controller2_register_debuggee_async.py | 51 - ...ated_controller2_register_debuggee_sync.py | 51 - ...troller2_update_active_breakpoint_async.py | 52 - ...ntroller2_update_active_breakpoint_sync.py | 52 - ...rated_debugger2_delete_breakpoint_async.py | 52 - ...erated_debugger2_delete_breakpoint_sync.py | 52 - ...enerated_debugger2_get_breakpoint_async.py | 54 - ...generated_debugger2_get_breakpoint_sync.py | 54 - ...erated_debugger2_list_breakpoints_async.py | 53 - ...nerated_debugger2_list_breakpoints_sync.py | 53 - ...enerated_debugger2_list_debuggees_async.py | 53 - ...generated_debugger2_list_debuggees_sync.py | 53 - ...enerated_debugger2_set_breakpoint_async.py | 53 - ...generated_debugger2_set_breakpoint_sync.py | 53 - ...data_google.devtools.clouddebugger.v2.json | 1369 ------- .../v2/scripts/fixup_debugger_v2_keywords.py | 183 - owl-bot-staging/v2/setup.py | 90 - .../v2/testing/constraints-3.10.txt | 6 - .../v2/testing/constraints-3.11.txt | 6 - .../v2/testing/constraints-3.12.txt | 6 - .../v2/testing/constraints-3.7.txt | 9 - .../v2/testing/constraints-3.8.txt | 6 - .../v2/testing/constraints-3.9.txt | 6 - 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 | 2551 ------------ .../unit/gapic/debugger_v2/test_debugger2.py | 3628 ----------------- 72 files changed, 1 insertion(+), 17483 deletions(-) delete mode 100644 owl-bot-staging/v2/.coveragerc delete mode 100644 owl-bot-staging/v2/.flake8 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/gapic_version.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/gapic_version.py 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/controller2/transports/rest.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/services/debugger2/transports/rest.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/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py delete mode 100644 owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json 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/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/v2/testing/constraints-3.9.txt 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/debugger2/transports/rest.py b/google/cloud/debugger_v2/services/debugger2/transports/rest.py index 56ed52e..02216ea 100644 --- a/google/cloud/debugger_v2/services/debugger2/transports/rest.py +++ b/google/cloud/debugger_v2/services/debugger2/transports/rest.py @@ -713,7 +713,7 @@ def __call__( { "method": "post", "uri": "/v2/debugger/debuggees/{debuggee_id}/breakpoints/set", - "body": "breakpoint", + "body": "breakpoint_", }, ] request, metadata = self._interceptor.pre_set_breakpoint(request, metadata) diff --git a/owl-bot-staging/v2/.coveragerc b/owl-bot-staging/v2/.coveragerc deleted file mode 100644 index 9620812..0000000 --- a/owl-bot-staging/v2/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/debugger/__init__.py - google/cloud/debugger/gapic_version.py -exclude_lines = - # Re-enable the standard pragma - pragma: NO COVER - # Ignore debug-only repr - def __repr__ diff --git a/owl-bot-staging/v2/.flake8 b/owl-bot-staging/v2/.flake8 deleted file mode 100644 index 29227d4..0000000 --- a/owl-bot-staging/v2/.flake8 +++ /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 -# -# https://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. - -# Generated by synthtool. DO NOT EDIT! -[flake8] -ignore = E203, E266, E501, W503 -exclude = - # Exclude generated code. - **/proto/** - **/gapic/** - **/services/** - **/types/** - *_pb2.py - - # Standard linting exemptions. - **/.nox/** - __pycache__, - .git, - *.pyc, - conf.py 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 4ad5ea1..0000000 --- a/owl-bot-staging/v2/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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"2022, 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 0106467..0000000 --- a/owl-bot-staging/v2/docs/debugger_v2/types.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Debugger v2 API -====================================== - -.. automodule:: google.cloud.debugger_v2.types - :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 1228468..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger/__init__.py +++ /dev/null @@ -1,75 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 import gapic_version as package_version - -__version__ = package_version.__version__ - - -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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py deleted file mode 100644 index 30274cc..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -__version__ = "0.0.0" # {x-release-please-version} 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 c774017..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/__init__.py +++ /dev/null @@ -1,76 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 import gapic_version as package_version - -__version__ = package_version.__version__ - - -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 f0d8a90..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_metadata.json +++ /dev/null @@ -1,167 +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" - ] - } - } - }, - "rest": { - "libraryClient": "Controller2Client", - "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" - ] - } - } - }, - "rest": { - "libraryClient": "Debugger2Client", - "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/gapic_version.py b/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py deleted file mode 100644 index 30274cc..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -__version__ = "0.0.0" # {x-release-please-version} 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 e8e1c38..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 e010a73..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 e81f163..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/async_client.py +++ /dev/null @@ -1,566 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 variable 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: Optional[ga_credentials.Credentials] = None, - transport: Union[str, Controller2Transport] = "grpc_asyncio", - client_options: Optional[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: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, - *, - debuggee: Optional[data.Debuggee] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = await client.register_debuggee(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint.id", request.breakpoint.id), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self) -> "Controller2AsyncClient": - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 7330718..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/client.py +++ /dev/null @@ -1,747 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 -from .transports.rest import Controller2RestTransport - - -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 - _transport_registry["rest"] = Controller2RestTransport - - def get_transport_class(cls, - label: Optional[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 variable 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: Optional[Union[str, Controller2Transport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() - client_options = cast(client_options_lib.ClientOptions, client_options) - - 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, - api_audience=client_options.api_audience, - ) - - def register_debuggee(self, - request: Optional[Union[controller.RegisterDebuggeeRequest, dict]] = None, - *, - debuggee: Optional[data.Debuggee] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = client.register_debuggee(request=request) - - # Handle the response - print(response) - - 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: Optional[Union[controller.ListActiveBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_active_breakpoint(self, - request: Optional[Union[controller.UpdateActiveBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - 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. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint.id", request.breakpoint.id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "Controller2Client": - 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() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 0381ff4..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -from .rest import Controller2RestTransport -from .rest import Controller2RestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[Controller2Transport]] -_transport_registry['grpc'] = Controller2GrpcTransport -_transport_registry['grpc_asyncio'] = Controller2GrpcAsyncIOTransport -_transport_registry['rest'] = Controller2RestTransport - -__all__ = ( - 'Controller2Transport', - 'Controller2GrpcTransport', - 'Controller2GrpcAsyncIOTransport', - 'Controller2RestTransport', - 'Controller2RestInterceptor', -) 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 8e480a6..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/base.py +++ /dev/null @@ -1,191 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -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: Optional[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, - api_audience: Optional[str] = None, - **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. - """ - - 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) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # 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 - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - 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() - - @property - def kind(self) -> str: - 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 09e2efa..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc.py +++ /dev/null @@ -1,369 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[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() - - @property - def kind(self) -> str: - return "grpc" - - -__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 ae65db1..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/grpc_asyncio.py +++ /dev/null @@ -1,368 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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/controller2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py deleted file mode 100644 index e172241..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/controller2/transports/rest.py +++ /dev/null @@ -1,553 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -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 .base import Controller2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class Controller2RestInterceptor: - """Interceptor for Controller2. - - Interceptors are used to manipulate requests, request metadata, and responses - in arbitrary ways. - Example use cases include: - * Logging - * Verifying requests according to service or custom semantics - * Stripping extraneous information from responses - - These use cases and more can be enabled by injecting an - instance of a custom subclass when constructing the Controller2RestTransport. - - .. code-block:: python - class MyCustomController2Interceptor(Controller2RestInterceptor): - def pre_list_active_breakpoints(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_active_breakpoints(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_register_debuggee(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_register_debuggee(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_active_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_active_breakpoint(self, response): - logging.log(f"Received response: {response}") - return response - - transport = Controller2RestTransport(interceptor=MyCustomController2Interceptor()) - client = Controller2Client(transport=transport) - - - """ - def pre_list_active_breakpoints(self, request: controller.ListActiveBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.ListActiveBreakpointsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_active_breakpoints - - Override in a subclass to manipulate the request or metadata - before they are sent to the Controller2 server. - """ - return request, metadata - - def post_list_active_breakpoints(self, response: controller.ListActiveBreakpointsResponse) -> controller.ListActiveBreakpointsResponse: - """Post-rpc interceptor for list_active_breakpoints - - Override in a subclass to manipulate the response - after it is returned by the Controller2 server but before - it is returned to user code. - """ - return response - def pre_register_debuggee(self, request: controller.RegisterDebuggeeRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.RegisterDebuggeeRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for register_debuggee - - Override in a subclass to manipulate the request or metadata - before they are sent to the Controller2 server. - """ - return request, metadata - - def post_register_debuggee(self, response: controller.RegisterDebuggeeResponse) -> controller.RegisterDebuggeeResponse: - """Post-rpc interceptor for register_debuggee - - Override in a subclass to manipulate the response - after it is returned by the Controller2 server but before - it is returned to user code. - """ - return response - def pre_update_active_breakpoint(self, request: controller.UpdateActiveBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[controller.UpdateActiveBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for update_active_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Controller2 server. - """ - return request, metadata - - def post_update_active_breakpoint(self, response: controller.UpdateActiveBreakpointResponse) -> controller.UpdateActiveBreakpointResponse: - """Post-rpc interceptor for update_active_breakpoint - - Override in a subclass to manipulate the response - after it is returned by the Controller2 server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class Controller2RestStub: - _session: AuthorizedSession - _host: str - _interceptor: Controller2RestInterceptor - - -class Controller2RestTransport(Controller2Transport): - """REST 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 JSON representations of protocol buffers over HTTP/1.1 - - """ - - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[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, - url_scheme: str = 'https', - interceptor: Optional[Controller2RestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> 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 ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` 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 are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or Controller2RestInterceptor() - self._prep_wrapped_messages(client_info) - - class _ListActiveBreakpoints(Controller2RestStub): - def __hash__(self): - return hash("ListActiveBreakpoints") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.ListActiveBreakpointsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.ListActiveBreakpointsResponse: - r"""Call the list active breakpoints method over HTTP. - - Args: - request (~.controller.ListActiveBreakpointsRequest): - The request object. Request to list active breakpoints. - 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: - ~.controller.ListActiveBreakpointsResponse: - Response for listing active - breakpoints. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints', - }, - ] - request, metadata = self._interceptor.pre_list_active_breakpoints(request, metadata) - pb_request = controller.ListActiveBreakpointsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = controller.ListActiveBreakpointsResponse() - pb_resp = controller.ListActiveBreakpointsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_active_breakpoints(resp) - return resp - - class _RegisterDebuggee(Controller2RestStub): - def __hash__(self): - return hash("RegisterDebuggee") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.RegisterDebuggeeRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.RegisterDebuggeeResponse: - r"""Call the register debuggee method over HTTP. - - Args: - request (~.controller.RegisterDebuggeeRequest): - The request object. Request to register a debuggee. - 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: - ~.controller.RegisterDebuggeeResponse: - Response for registering a debuggee. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v2/controller/debuggees/register', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_register_debuggee(request, metadata) - pb_request = controller.RegisterDebuggeeRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = controller.RegisterDebuggeeResponse() - pb_resp = controller.RegisterDebuggeeResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_register_debuggee(resp) - return resp - - class _UpdateActiveBreakpoint(Controller2RestStub): - def __hash__(self): - return hash("UpdateActiveBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: controller.UpdateActiveBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> controller.UpdateActiveBreakpointResponse: - r"""Call the update active breakpoint method over HTTP. - - Args: - request (~.controller.UpdateActiveBreakpointRequest): - The request object. Request to update an active - breakpoint. - 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: - ~.controller.UpdateActiveBreakpointResponse: - Response for updating an active - breakpoint. The message is defined to - allow future extensions. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'put', - 'uri': '/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}', - 'body': '*', - }, - ] - request, metadata = self._interceptor.pre_update_active_breakpoint(request, metadata) - pb_request = controller.UpdateActiveBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = controller.UpdateActiveBreakpointResponse() - pb_resp = controller.UpdateActiveBreakpointResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_update_active_breakpoint(resp) - return resp - - @property - def list_active_breakpoints(self) -> Callable[ - [controller.ListActiveBreakpointsRequest], - controller.ListActiveBreakpointsResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListActiveBreakpoints(self._session, self._host, self._interceptor) # type: ignore - - @property - def register_debuggee(self) -> Callable[ - [controller.RegisterDebuggeeRequest], - controller.RegisterDebuggeeResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._RegisterDebuggee(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_active_breakpoint(self) -> Callable[ - [controller.UpdateActiveBreakpointRequest], - controller.UpdateActiveBreakpointResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._UpdateActiveBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'Controller2RestTransport', -) 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 5d7f609..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 07420ee..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/async_client.py +++ /dev/null @@ -1,806 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 variable 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: Optional[ga_credentials.Credentials] = None, - transport: Union[str, Debugger2Transport] = "grpc_asyncio", - client_options: Optional[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: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.SetBreakpointResponse: - r"""Sets the breakpoint to the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.set_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.GetBreakpointResponse: - r"""Gets breakpoint information. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.get_breakpoint(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # 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: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the breakpoint from the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - await client.delete_breakpoint(request=request) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def list_breakpoints(self, - request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListBreakpointsResponse: - r"""Lists all breakpoints for the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_breakpoints(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # 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: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, - *, - project: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListDebuggeesResponse: - r"""Lists all the debuggees that the user has access to. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - async def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_debuggees(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[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) -> "Debugger2AsyncClient": - return self - - async def __aexit__(self, exc_type, exc, tb): - await self.transport.close() - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 7e52f8d..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/client.py +++ /dev/null @@ -1,973 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 -from .transports.rest import Debugger2RestTransport - - -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 - _transport_registry["rest"] = Debugger2RestTransport - - def get_transport_class(cls, - label: Optional[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 variable 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: Optional[Union[str, Debugger2Transport]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = 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 (Optional[Union[google.api_core.client_options.ClientOptions, dict]]): 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() - client_options = cast(client_options_lib.ClientOptions, client_options) - - 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, - api_audience=client_options.api_audience, - ) - - def set_breakpoint(self, - request: Optional[Union[debugger.SetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_: Optional[data.Breakpoint] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.SetBreakpointResponse: - r"""Sets the breakpoint to the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.set_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_breakpoint(self, - request: Optional[Union[debugger.GetBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.GetBreakpointResponse: - r"""Gets breakpoint information. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.get_breakpoint(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_breakpoint(self, - request: Optional[Union[debugger.DeleteBreakpointRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - breakpoint_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes the breakpoint from the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - client.delete_breakpoint(request=request) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - ("breakpoint_id", request.breakpoint_id), - )), - ) - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def list_breakpoints(self, - request: Optional[Union[debugger.ListBreakpointsRequest, dict]] = None, - *, - debuggee_id: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListBreakpointsResponse: - r"""Lists all breakpoints for the debuggee. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_breakpoints(request=request) - - # Handle the response - print(response) - - 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] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("debuggee_id", request.debuggee_id), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def list_debuggees(self, - request: Optional[Union[debugger.ListDebuggeesRequest, dict]] = None, - *, - project: Optional[str] = None, - client_version: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> debugger.ListDebuggeesResponse: - r"""Lists all the debuggees that the user has access to. - - .. code-block:: python - - # This snippet has been automatically generated and should be regarded as a - # code template only. - # It will require modifications to work: - # - It may require correct/in-range values for request initialization. - # - It may require specifying regional endpoints when creating the service - # client as shown in: - # https://googleapis.dev/python/google-api-core/latest/client_options.html - from google.cloud import debugger_v2 - - def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_debuggees(request=request) - - # Handle the response - print(response) - - 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) -> "Debugger2Client": - 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() - - - - - - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -__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 cd9dd46..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -from .rest import Debugger2RestTransport -from .rest import Debugger2RestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[Debugger2Transport]] -_transport_registry['grpc'] = Debugger2GrpcTransport -_transport_registry['grpc_asyncio'] = Debugger2GrpcAsyncIOTransport -_transport_registry['rest'] = Debugger2RestTransport - -__all__ = ( - 'Debugger2Transport', - 'Debugger2GrpcTransport', - 'Debugger2GrpcAsyncIOTransport', - 'Debugger2RestTransport', - 'Debugger2RestInterceptor', -) 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 c4afc0c..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/base.py +++ /dev/null @@ -1,234 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -from google.cloud.debugger_v2 import gapic_version as package_version - -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 - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -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: Optional[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, - api_audience: Optional[str] = None, - **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. - """ - - 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) - # Don't apply audience if the credentials file passed from user. - if hasattr(credentials, "with_gdch_audience"): - credentials = credentials.with_gdch_audience(api_audience if api_audience else host) - - # 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 - - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - 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() - - @property - def kind(self) -> str: - 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 fbb3374..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc.py +++ /dev/null @@ -1,381 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[grpc.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[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() - - @property - def kind(self) -> str: - return "grpc" - - -__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 eb6eadc..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/grpc_asyncio.py +++ /dev/null @@ -1,380 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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: Optional[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: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[aio.Channel] = None, - api_mtls_endpoint: Optional[str] = None, - client_cert_source: Optional[Callable[[], Tuple[bytes, bytes]]] = None, - ssl_channel_credentials: Optional[grpc.ChannelCredentials] = None, - client_cert_source_for_mtls: Optional[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, - api_audience: Optional[str] = None, - ) -> 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, - api_audience=api_audience, - ) - - 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/services/debugger2/transports/rest.py b/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py deleted file mode 100644 index 17e5c4f..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/services/debugger2/transports/rest.py +++ /dev/null @@ -1,729 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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.auth.transport.requests import AuthorizedSession # type: ignore -import json # type: ignore -import grpc # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore -from google.auth import credentials as ga_credentials # type: ignore -from google.api_core import exceptions as core_exceptions -from google.api_core import retry as retries -from google.api_core import rest_helpers -from google.api_core import rest_streaming -from google.api_core import path_template -from google.api_core import gapic_v1 - -from google.protobuf import json_format -from requests import __version__ as requests_version -import dataclasses -import re -from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union -import warnings - -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 debugger -from google.protobuf import empty_pb2 # type: ignore - -from .base import Debugger2Transport, DEFAULT_CLIENT_INFO as BASE_DEFAULT_CLIENT_INFO - - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=BASE_DEFAULT_CLIENT_INFO.gapic_version, - grpc_version=None, - rest_version=requests_version, -) - - -class Debugger2RestInterceptor: - """Interceptor for Debugger2. - - Interceptors are used to manipulate requests, request metadata, and responses - in arbitrary ways. - Example use cases include: - * Logging - * Verifying requests according to service or custom semantics - * Stripping extraneous information from responses - - These use cases and more can be enabled by injecting an - instance of a custom subclass when constructing the Debugger2RestTransport. - - .. code-block:: python - class MyCustomDebugger2Interceptor(Debugger2RestInterceptor): - def pre_delete_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def pre_get_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_breakpoint(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_breakpoints(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_breakpoints(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_list_debuggees(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_list_debuggees(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_set_breakpoint(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_set_breakpoint(self, response): - logging.log(f"Received response: {response}") - return response - - transport = Debugger2RestTransport(interceptor=MyCustomDebugger2Interceptor()) - client = Debugger2Client(transport=transport) - - - """ - def pre_delete_breakpoint(self, request: debugger.DeleteBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.DeleteBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for delete_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def pre_get_breakpoint(self, request: debugger.GetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.GetBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_get_breakpoint(self, response: debugger.GetBreakpointResponse) -> debugger.GetBreakpointResponse: - """Post-rpc interceptor for get_breakpoint - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - def pre_list_breakpoints(self, request: debugger.ListBreakpointsRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListBreakpointsRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_breakpoints - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_list_breakpoints(self, response: debugger.ListBreakpointsResponse) -> debugger.ListBreakpointsResponse: - """Post-rpc interceptor for list_breakpoints - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - def pre_list_debuggees(self, request: debugger.ListDebuggeesRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.ListDebuggeesRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for list_debuggees - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_list_debuggees(self, response: debugger.ListDebuggeesResponse) -> debugger.ListDebuggeesResponse: - """Post-rpc interceptor for list_debuggees - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - def pre_set_breakpoint(self, request: debugger.SetBreakpointRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[debugger.SetBreakpointRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for set_breakpoint - - Override in a subclass to manipulate the request or metadata - before they are sent to the Debugger2 server. - """ - return request, metadata - - def post_set_breakpoint(self, response: debugger.SetBreakpointResponse) -> debugger.SetBreakpointResponse: - """Post-rpc interceptor for set_breakpoint - - Override in a subclass to manipulate the response - after it is returned by the Debugger2 server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class Debugger2RestStub: - _session: AuthorizedSession - _host: str - _interceptor: Debugger2RestInterceptor - - -class Debugger2RestTransport(Debugger2Transport): - """REST 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 JSON representations of protocol buffers over HTTP/1.1 - - """ - - def __init__(self, *, - host: str = 'clouddebugger.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - client_cert_source_for_mtls: Optional[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, - url_scheme: str = 'https', - interceptor: Optional[Debugger2RestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> 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 ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - client_cert_source_for_mtls (Callable[[], Tuple[bytes, bytes]]): Client - certificate to configure mutual TLS HTTP channel. It is ignored - if ``channel`` 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 are developing - your own client library. - always_use_jwt_access (Optional[bool]): Whether self signed JWT should - be used for service account credentials. - url_scheme: the protocol scheme for the API endpoint. Normally - "https", but for testing or local servers, - "http" can be specified. - """ - # Run the base constructor - # TODO(yon-mg): resolve other ctor params i.e. scopes, quota, etc. - # TODO: When custom host (api_endpoint) is set, `scopes` must *also* be set on the - # credentials object - maybe_url_match = re.match("^(?Phttp(?:s)?://)?(?P.*)$", host) - if maybe_url_match is None: - raise ValueError(f"Unexpected hostname structure: {host}") # pragma: NO COVER - - url_match_items = maybe_url_match.groupdict() - - host = f"{url_scheme}://{host}" if not url_match_items["scheme"] else host - - super().__init__( - host=host, - credentials=credentials, - client_info=client_info, - always_use_jwt_access=always_use_jwt_access, - api_audience=api_audience - ) - self._session = AuthorizedSession( - self._credentials, default_host=self.DEFAULT_HOST) - if client_cert_source_for_mtls: - self._session.configure_mtls_channel(client_cert_source_for_mtls) - self._interceptor = interceptor or Debugger2RestInterceptor() - self._prep_wrapped_messages(client_info) - - class _DeleteBreakpoint(Debugger2RestStub): - def __hash__(self): - return hash("DeleteBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.DeleteBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ): - r"""Call the delete breakpoint method over HTTP. - - Args: - request (~.debugger.DeleteBreakpointRequest): - The request object. Request to delete a breakpoint. - 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. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'delete', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', - }, - ] - request, metadata = self._interceptor.pre_delete_breakpoint(request, metadata) - pb_request = debugger.DeleteBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - class _GetBreakpoint(Debugger2RestStub): - def __hash__(self): - return hash("GetBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.GetBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.GetBreakpointResponse: - r"""Call the get breakpoint method over HTTP. - - Args: - request (~.debugger.GetBreakpointRequest): - The request object. Request to get breakpoint - information. - 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: - ~.debugger.GetBreakpointResponse: - Response for getting breakpoint - information. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}', - }, - ] - request, metadata = self._interceptor.pre_get_breakpoint(request, metadata) - pb_request = debugger.GetBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.GetBreakpointResponse() - pb_resp = debugger.GetBreakpointResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_breakpoint(resp) - return resp - - class _ListBreakpoints(Debugger2RestStub): - def __hash__(self): - return hash("ListBreakpoints") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.ListBreakpointsRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.ListBreakpointsResponse: - r"""Call the list breakpoints method over HTTP. - - Args: - request (~.debugger.ListBreakpointsRequest): - The request object. Request to list breakpoints. - 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: - ~.debugger.ListBreakpointsResponse: - Response for listing breakpoints. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints', - }, - ] - request, metadata = self._interceptor.pre_list_breakpoints(request, metadata) - pb_request = debugger.ListBreakpointsRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.ListBreakpointsResponse() - pb_resp = debugger.ListBreakpointsResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_breakpoints(resp) - return resp - - class _ListDebuggees(Debugger2RestStub): - def __hash__(self): - return hash("ListDebuggees") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "project" : "", "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.ListDebuggeesRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.ListDebuggeesResponse: - r"""Call the list debuggees method over HTTP. - - Args: - request (~.debugger.ListDebuggeesRequest): - The request object. Request to list debuggees. - 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: - ~.debugger.ListDebuggeesResponse: - Response for listing debuggees. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v2/debugger/debuggees', - }, - ] - request, metadata = self._interceptor.pre_list_debuggees(request, metadata) - pb_request = debugger.ListDebuggeesRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.ListDebuggeesResponse() - pb_resp = debugger.ListDebuggeesResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_list_debuggees(resp) - return resp - - class _SetBreakpoint(Debugger2RestStub): - def __hash__(self): - return hash("SetBreakpoint") - - __REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = { - "breakpoint" : {}, "clientVersion" : "", } - - @classmethod - def _get_unset_required_fields(cls, message_dict): - return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict} - - def __call__(self, - request: debugger.SetBreakpointRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> debugger.SetBreakpointResponse: - r"""Call the set breakpoint method over HTTP. - - Args: - request (~.debugger.SetBreakpointRequest): - The request object. Request to set a breakpoint - 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: - ~.debugger.SetBreakpointResponse: - Response for setting a breakpoint. - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v2/debugger/debuggees/{debuggee_id}/breakpoints/set', - 'body': 'breakpoint_', - }, - ] - request, metadata = self._interceptor.pre_set_breakpoint(request, metadata) - pb_request = debugger.SetBreakpointRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - including_default_value_fields=False, - use_integers_for_enums=True - ) - uri = transcoded_request['uri'] - method = transcoded_request['method'] - - # Jsonify the query params - query_params = json.loads(json_format.MessageToJson( - transcoded_request['query_params'], - including_default_value_fields=False, - use_integers_for_enums=True, - )) - query_params.update(self._get_unset_required_fields(query_params)) - - query_params["$alt"] = "json;enum-encoding=int" - - # Send the request - headers = dict(metadata) - headers['Content-Type'] = 'application/json' - response = getattr(self._session, method)( - "{host}{uri}".format(host=self._host, uri=uri), - timeout=timeout, - headers=headers, - params=rest_helpers.flatten_query_params(query_params, strict=True), - data=body, - ) - - # In case of error, raise the appropriate core_exceptions.GoogleAPICallError exception - # subclass. - if response.status_code >= 400: - raise core_exceptions.from_http_response(response) - - # Return the response - resp = debugger.SetBreakpointResponse() - pb_resp = debugger.SetBreakpointResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_set_breakpoint(resp) - return resp - - @property - def delete_breakpoint(self) -> Callable[ - [debugger.DeleteBreakpointRequest], - empty_pb2.Empty]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._DeleteBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_breakpoint(self) -> Callable[ - [debugger.GetBreakpointRequest], - debugger.GetBreakpointResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._GetBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_breakpoints(self) -> Callable[ - [debugger.ListBreakpointsRequest], - debugger.ListBreakpointsResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListBreakpoints(self._session, self._host, self._interceptor) # type: ignore - - @property - def list_debuggees(self) -> Callable[ - [debugger.ListDebuggeesRequest], - debugger.ListDebuggeesResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._ListDebuggees(self._session, self._host, self._interceptor) # type: ignore - - @property - def set_breakpoint(self) -> Callable[ - [debugger.SetBreakpointRequest], - debugger.SetBreakpointResponse]: - # The return type is fine, but mypy isn't sophisticated enough to determine what's going on here. - # In C++ this would require a dynamic_cast - return self._SetBreakpoint(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'Debugger2RestTransport', -) 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 9791b6c..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/__init__.py +++ /dev/null @@ -1,68 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 2ed0286..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/controller.py +++ /dev/null @@ -1,176 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -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: data.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: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - wait_token: str = proto.Field( - proto.STRING, - number=2, - ) - success_on_timeout: bool = proto.Field( - proto.BOOL, - number=3, - ) - - -class ListActiveBreakpointsResponse(proto.Message): - r"""Response for listing active breakpoints. - - Attributes: - breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - next_wait_token: str = proto.Field( - proto.STRING, - number=2, - ) - wait_expired: bool = 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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_: data.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 42e4206..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/data.py +++ /dev/null @@ -1,681 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -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 (MutableSequence[str]): - Optional parameters to be embedded into the - message. - """ - - format_: str = proto.Field( - proto.STRING, - number=1, - ) - parameters: MutableSequence[str] = 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. - - Values: - UNSPECIFIED (0): - Status doesn't refer to any particular input. - BREAKPOINT_SOURCE_LOCATION (3): - Status applies to the breakpoint and is - related to its location. - BREAKPOINT_CONDITION (4): - Status applies to the breakpoint and is - related to its condition. - BREAKPOINT_EXPRESSION (7): - Status applies to the breakpoint and is - related to its expressions. - BREAKPOINT_AGE (8): - Status applies to the breakpoint and is - related to its age. - VARIABLE_NAME (5): - Status applies to the entire variable. - VARIABLE_VALUE (6): - Status applies to variable value (variable - name is valid). - """ - UNSPECIFIED = 0 - BREAKPOINT_SOURCE_LOCATION = 3 - BREAKPOINT_CONDITION = 4 - BREAKPOINT_EXPRESSION = 7 - BREAKPOINT_AGE = 8 - VARIABLE_NAME = 5 - VARIABLE_VALUE = 6 - - is_error: bool = proto.Field( - proto.BOOL, - number=1, - ) - refers_to: Reference = proto.Field( - proto.ENUM, - number=2, - enum=Reference, - ) - description: 'FormatMessage' = 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: str = proto.Field( - proto.STRING, - number=1, - ) - line: int = proto.Field( - proto.INT32, - number=2, - ) - column: int = 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 (MutableSequence[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: str = proto.Field( - proto.STRING, - number=1, - ) - value: str = proto.Field( - proto.STRING, - number=2, - ) - type_: str = proto.Field( - proto.STRING, - number=6, - ) - members: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Variable', - ) - var_table_index: wrappers_pb2.Int32Value = proto.Field( - proto.MESSAGE, - number=4, - message=wrappers_pb2.Int32Value, - ) - status: 'StatusMessage' = 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 (MutableSequence[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_ (MutableSequence[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: str = proto.Field( - proto.STRING, - number=1, - ) - location: 'SourceLocation' = proto.Field( - proto.MESSAGE, - number=2, - message='SourceLocation', - ) - arguments: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=3, - message='Variable', - ) - locals_: MutableSequence['Variable'] = 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 (MutableSequence[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 (MutableSequence[google.cloud.debugger_v2.types.StackFrame]): - The stack at breakpoint time, where stack_frames[0] - represents the most recently entered function. - evaluated_expressions (MutableSequence[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 (MutableSequence[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 (MutableMapping[str, str]): - 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. - - Values: - CAPTURE (0): - Capture stack frame and variables and update - the breakpoint. The data is only captured once. - After that the breakpoint is set in a final - state. - LOG (1): - Log each breakpoint hit. The breakpoint - remains active until deleted or expired. - """ - CAPTURE = 0 - LOG = 1 - - class LogLevel(proto.Enum): - r"""Log severity levels. - - Values: - INFO (0): - Information log message. - WARNING (1): - Warning log message. - ERROR (2): - Error log message. - """ - INFO = 0 - WARNING = 1 - ERROR = 2 - - id: str = proto.Field( - proto.STRING, - number=1, - ) - action: Action = proto.Field( - proto.ENUM, - number=13, - enum=Action, - ) - location: 'SourceLocation' = proto.Field( - proto.MESSAGE, - number=2, - message='SourceLocation', - ) - condition: str = proto.Field( - proto.STRING, - number=3, - ) - expressions: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=4, - ) - log_message_format: str = proto.Field( - proto.STRING, - number=14, - ) - log_level: LogLevel = proto.Field( - proto.ENUM, - number=15, - enum=LogLevel, - ) - is_final_state: bool = proto.Field( - proto.BOOL, - number=5, - ) - create_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=11, - message=timestamp_pb2.Timestamp, - ) - final_time: timestamp_pb2.Timestamp = proto.Field( - proto.MESSAGE, - number=12, - message=timestamp_pb2.Timestamp, - ) - user_email: str = proto.Field( - proto.STRING, - number=16, - ) - status: 'StatusMessage' = proto.Field( - proto.MESSAGE, - number=10, - message='StatusMessage', - ) - stack_frames: MutableSequence['StackFrame'] = proto.RepeatedField( - proto.MESSAGE, - number=7, - message='StackFrame', - ) - evaluated_expressions: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=8, - message='Variable', - ) - variable_table: MutableSequence['Variable'] = proto.RepeatedField( - proto.MESSAGE, - number=9, - message='Variable', - ) - labels: MutableMapping[str, str] = 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 (MutableSequence[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 (MutableSequence[google.devtools.source.v1.source_context_pb2.ExtendedSourceContext]): - References to the locations and revisions of - the source code used in the deployed - application. - labels (MutableMapping[str, str]): - A set of custom debuggee properties, - populated by the agent, to be displayed to the - user. - """ - - id: str = proto.Field( - proto.STRING, - number=1, - ) - project: str = proto.Field( - proto.STRING, - number=2, - ) - uniquifier: str = proto.Field( - proto.STRING, - number=3, - ) - description: str = proto.Field( - proto.STRING, - number=4, - ) - is_inactive: bool = proto.Field( - proto.BOOL, - number=5, - ) - agent_version: str = proto.Field( - proto.STRING, - number=6, - ) - is_disabled: bool = proto.Field( - proto.BOOL, - number=7, - ) - status: 'StatusMessage' = proto.Field( - proto.MESSAGE, - number=8, - message='StatusMessage', - ) - source_contexts: MutableSequence[source_context_pb2.SourceContext] = proto.RepeatedField( - proto.MESSAGE, - number=9, - message=source_context_pb2.SourceContext, - ) - ext_source_contexts: MutableSequence[source_context_pb2.ExtendedSourceContext] = proto.RepeatedField( - proto.MESSAGE, - number=13, - message=source_context_pb2.ExtendedSourceContext, - ) - labels: MutableMapping[str, str] = 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 0c2fa0a..0000000 --- a/owl-bot-staging/v2/google/cloud/debugger_v2/types/debugger.py +++ /dev/null @@ -1,315 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 __future__ import annotations - -from typing import MutableMapping, MutableSequence - -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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_: data.Breakpoint = proto.Field( - proto.MESSAGE, - number=2, - message=data.Breakpoint, - ) - client_version: str = 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_: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_id: str = proto.Field( - proto.STRING, - number=2, - ) - client_version: str = 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_: data.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: str = proto.Field( - proto.STRING, - number=1, - ) - breakpoint_id: str = proto.Field( - proto.STRING, - number=2, - ) - client_version: str = 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: data.Breakpoint.Action = proto.Field( - proto.ENUM, - number=1, - enum=data.Breakpoint.Action, - ) - - debuggee_id: str = proto.Field( - proto.STRING, - number=1, - ) - include_all_users: bool = proto.Field( - proto.BOOL, - number=2, - ) - include_inactive: bool = proto.Field( - proto.BOOL, - number=3, - ) - action: BreakpointActionValue = proto.Field( - proto.MESSAGE, - number=4, - message=BreakpointActionValue, - ) - strip_results: bool = proto.Field( - proto.BOOL, - number=5, - ) - wait_token: str = proto.Field( - proto.STRING, - number=6, - ) - client_version: str = proto.Field( - proto.STRING, - number=8, - ) - - -class ListBreakpointsResponse(proto.Message): - r"""Response for listing breakpoints. - - Attributes: - breakpoints (MutableSequence[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: MutableSequence[data.Breakpoint] = proto.RepeatedField( - proto.MESSAGE, - number=1, - message=data.Breakpoint, - ) - next_wait_token: str = 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: str = proto.Field( - proto.STRING, - number=2, - ) - include_inactive: bool = proto.Field( - proto.BOOL, - number=3, - ) - client_version: str = proto.Field( - proto.STRING, - number=4, - ) - - -class ListDebuggeesResponse(proto.Message): - r"""Response for listing debuggees. - - Attributes: - debuggees (MutableSequence[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: MutableSequence[data.Debuggee] = 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 574c5ae..0000000 --- a/owl-bot-staging/v2/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/v2/noxfile.py b/owl-bot-staging/v2/noxfile.py deleted file mode 100644 index 02ef930..0000000 --- a/owl-bot-staging/v2/noxfile.py +++ /dev/null @@ -1,184 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", -] - -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") - -BLACK_VERSION = "black==22.3.0" -BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] -DEFAULT_PYTHON_VERSION = "3.11" - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", - "blacken", - "lint", - "lint_setup_py", -] - -@nox.session(python=ALL_PYTHON) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/debugger_v2/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -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=ALL_PYTHON) -def mypy(session): - """Run the type checker.""" - session.install( - 'mypy', - 'types-requests', - 'types-protobuf' - ) - 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=DEFAULT_PYTHON_VERSION) -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", ""), - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint(session): - """Run linters. - - Returns a failure if the linters find linting errors or sufficiently - serious code quality issues. - """ - session.install("flake8", BLACK_VERSION) - session.run( - "black", - "--check", - *BLACK_PATHS, - ) - session.run("flake8", "google", "tests", "samples") - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def blacken(session): - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - session.run( - "black", - *BLACK_PATHS, - ) - - -@nox.session(python=DEFAULT_PYTHON_VERSION) -def lint_setup_py(session): - """Verify that setup.py is valid (including RST check).""" - session.install("docutils", "pygments") - session.run("python", "setup.py", "check", "--restructuredtext", "--strict") diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py deleted file mode 100644 index 24f6ea0..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListActiveBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py deleted file mode 100644 index 67c27c7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListActiveBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_active_breakpoints(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.ListActiveBreakpointsRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.list_active_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py deleted file mode 100644 index b0ac801..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_async.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDebuggee -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = await client.register_debuggee(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py deleted file mode 100644 index 99f6287..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_register_debuggee_sync.py +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for RegisterDebuggee -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_register_debuggee(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.RegisterDebuggeeRequest( - ) - - # Make the request - response = client.register_debuggee(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py deleted file mode 100644 index e74e3e7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateActiveBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = await client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py deleted file mode 100644 index 10a9948..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for UpdateActiveBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_update_active_breakpoint(): - # Create a client - client = debugger_v2.Controller2Client() - - # Initialize request argument(s) - request = debugger_v2.UpdateActiveBreakpointRequest( - debuggee_id="debuggee_id_value", - ) - - # Make the request - response = client.update_active_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py deleted file mode 100644 index b445c89..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - await client.delete_breakpoint(request=request) - - -# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py deleted file mode 100644 index 01599f2..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for DeleteBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_delete_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.DeleteBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - client.delete_breakpoint(request=request) - - -# [END clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py deleted file mode 100644 index 7074dcf..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_async.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.get_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py deleted file mode 100644 index 3f7ebd0..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py +++ /dev/null @@ -1,54 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for GetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_get_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.GetBreakpointRequest( - debuggee_id="debuggee_id_value", - breakpoint_id="breakpoint_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.get_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py deleted file mode 100644 index 816dd2b..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py deleted file mode 100644 index 4f65108..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListBreakpoints -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_breakpoints(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListBreakpointsRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_breakpoints(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py deleted file mode 100644 index fda422c..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListDebuggees -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.list_debuggees(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py deleted file mode 100644 index 246e83f..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_list_debuggees_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for ListDebuggees -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_list_debuggees(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.ListDebuggeesRequest( - project="project_value", - client_version="client_version_value", - ) - - # Make the request - response = client.list_debuggees(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_ListDebuggees_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py deleted file mode 100644 index 6267555..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -async def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2AsyncClient() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = await client.set_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_async] diff --git a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py b/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py deleted file mode 100644 index 22b41d7..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py +++ /dev/null @@ -1,53 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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. -# -# Generated code. DO NOT EDIT! -# -# Snippet for SetBreakpoint -# NOTE: This snippet has been automatically generated for illustrative purposes only. -# It may require modifications to work in your environment. - -# To install the latest published package dependency, execute the following: -# python3 -m pip install google-cloud-debugger-client - - -# [START clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] -# This snippet has been automatically generated and should be regarded as a -# code template only. -# It will require modifications to work: -# - It may require correct/in-range values for request initialization. -# - It may require specifying regional endpoints when creating the service -# client as shown in: -# https://googleapis.dev/python/google-api-core/latest/client_options.html -from google.cloud import debugger_v2 - - -def sample_set_breakpoint(): - # Create a client - client = debugger_v2.Debugger2Client() - - # Initialize request argument(s) - request = debugger_v2.SetBreakpointRequest( - debuggee_id="debuggee_id_value", - client_version="client_version_value", - ) - - # Make the request - response = client.set_breakpoint(request=request) - - # Handle the response - print(response) - -# [END clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync] diff --git a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json b/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json deleted file mode 100644 index ab6c88f..0000000 --- a/owl-bot-staging/v2/samples/generated_samples/snippet_metadata_google.devtools.clouddebugger.v2.json +++ /dev/null @@ -1,1369 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.devtools.clouddebugger.v2", - "version": "v2" - } - ], - "language": "PYTHON", - "name": "google-cloud-debugger-client", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.list_active_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "ListActiveBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", - "shortName": "list_active_breakpoints" - }, - "description": "Sample for ListActiveBreakpoints", - "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.list_active_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.ListActiveBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "ListActiveBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListActiveBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListActiveBreakpointsResponse", - "shortName": "list_active_breakpoints" - }, - "description": "Sample for ListActiveBreakpoints", - "file": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_ListActiveBreakpoints_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_list_active_breakpoints_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.register_debuggee", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "RegisterDebuggee" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" - }, - { - "name": "debuggee", - "type": "google.cloud.debugger_v2.types.Debuggee" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", - "shortName": "register_debuggee" - }, - "description": "Sample for RegisterDebuggee", - "file": "clouddebugger_v2_generated_controller2_register_debuggee_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_async", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_register_debuggee_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.register_debuggee", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.RegisterDebuggee", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "RegisterDebuggee" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.RegisterDebuggeeRequest" - }, - { - "name": "debuggee", - "type": "google.cloud.debugger_v2.types.Debuggee" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.RegisterDebuggeeResponse", - "shortName": "register_debuggee" - }, - "description": "Sample for RegisterDebuggee", - "file": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_RegisterDebuggee_sync", - "segments": [ - { - "end": 50, - "start": 27, - "type": "FULL" - }, - { - "end": 50, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 44, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 47, - "start": 45, - "type": "REQUEST_EXECUTION" - }, - { - "end": 51, - "start": 48, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_register_debuggee_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient", - "shortName": "Controller2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Controller2AsyncClient.update_active_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "UpdateActiveBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", - "shortName": "update_active_breakpoint" - }, - "description": "Sample for UpdateActiveBreakpoint", - "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Controller2Client", - "shortName": "Controller2Client" - }, - "fullName": "google.cloud.debugger_v2.Controller2Client.update_active_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Controller2.UpdateActiveBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Controller2", - "shortName": "Controller2" - }, - "shortName": "UpdateActiveBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.UpdateActiveBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.UpdateActiveBreakpointResponse", - "shortName": "update_active_breakpoint" - }, - "description": "Sample for UpdateActiveBreakpoint", - "file": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Controller2_UpdateActiveBreakpoint_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 48, - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "start": 49, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_controller2_update_active_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.delete_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "DeleteBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_breakpoint" - }, - "description": "Sample for DeleteBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_async", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.delete_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.DeleteBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "DeleteBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.DeleteBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_breakpoint" - }, - "description": "Sample for DeleteBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_DeleteBreakpoint_sync", - "segments": [ - { - "end": 51, - "start": 27, - "type": "FULL" - }, - { - "end": 51, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 52, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_delete_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.get_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "GetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", - "shortName": "get_breakpoint" - }, - "description": "Sample for GetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_async", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.get_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.GetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "GetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.GetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.GetBreakpointResponse", - "shortName": "get_breakpoint" - }, - "description": "Sample for GetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_GetBreakpoint_sync", - "segments": [ - { - "end": 53, - "start": 27, - "type": "FULL" - }, - { - "end": 53, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 47, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 50, - "start": 48, - "type": "REQUEST_EXECUTION" - }, - { - "end": 54, - "start": 51, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_get_breakpoint_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", - "shortName": "list_breakpoints" - }, - "description": "Sample for ListBreakpoints", - "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.list_breakpoints", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListBreakpoints", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListBreakpoints" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListBreakpointsRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListBreakpointsResponse", - "shortName": "list_breakpoints" - }, - "description": "Sample for ListBreakpoints", - "file": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListBreakpoints_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_breakpoints_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.list_debuggees", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListDebuggees" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" - }, - { - "name": "project", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", - "shortName": "list_debuggees" - }, - "description": "Sample for ListDebuggees", - "file": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_debuggees_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.list_debuggees", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.ListDebuggees", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "ListDebuggees" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.ListDebuggeesRequest" - }, - { - "name": "project", - "type": "str" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.ListDebuggeesResponse", - "shortName": "list_debuggees" - }, - "description": "Sample for ListDebuggees", - "file": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_ListDebuggees_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_list_debuggees_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient", - "shortName": "Debugger2AsyncClient" - }, - "fullName": "google.cloud.debugger_v2.Debugger2AsyncClient.set_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "SetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", - "shortName": "set_breakpoint" - }, - "description": "Sample for SetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_async", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.debugger_v2.Debugger2Client", - "shortName": "Debugger2Client" - }, - "fullName": "google.cloud.debugger_v2.Debugger2Client.set_breakpoint", - "method": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2.SetBreakpoint", - "service": { - "fullName": "google.devtools.clouddebugger.v2.Debugger2", - "shortName": "Debugger2" - }, - "shortName": "SetBreakpoint" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.debugger_v2.types.SetBreakpointRequest" - }, - { - "name": "debuggee_id", - "type": "str" - }, - { - "name": "breakpoint_", - "type": "google.cloud.debugger_v2.types.Breakpoint" - }, - { - "name": "client_version", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.debugger_v2.types.SetBreakpointResponse", - "shortName": "set_breakpoint" - }, - "description": "Sample for SetBreakpoint", - "file": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "clouddebugger_v2_generated_Debugger2_SetBreakpoint_sync", - "segments": [ - { - "end": 52, - "start": 27, - "type": "FULL" - }, - { - "end": 52, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 46, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "end": 49, - "start": 47, - "type": "REQUEST_EXECUTION" - }, - { - "end": 53, - "start": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "clouddebugger_v2_generated_debugger2_set_breakpoint_sync.py" - } - ] -} 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 9802c14..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 2022 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 4295418..0000000 --- a/owl-bot-staging/v2/setup.py +++ /dev/null @@ -1,90 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-cloud-debugger-client' - - -description = "Google Cloud Debugger Client API client library" - -version = {} -with open(os.path.join(package_root, 'google/cloud/debugger/gapic_version.py')) as fp: - exec(fp.read(), version) -version = version["__version__"] - -if version[0] == "0": - release_status = "Development Status :: 4 - Beta" -else: - release_status = "Development Status :: 5 - Production/Stable" - -dependencies = [ - "google-api-core[grpc] >= 1.34.0, <3.0.0dev,!=2.0.*,!=2.1.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,!=2.10.*", - "proto-plus >= 1.22.0, <2.0.0dev", - "proto-plus >= 1.22.2, <2.0.0dev; python_version>='3.11'", - "protobuf>=3.19.5,<5.0.0dev,!=3.20.0,!=3.20.1,!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5", -] -url = "https://github.com/googleapis/python-debugger-client" - -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() - -packages = [ - package - for package in setuptools.PEP420PackageFinder.find() - if package.startswith("google") -] - -namespaces = ["google", "google.cloud"] - -setuptools.setup( - name=name, - version=version, - description=description, - long_description=readme, - author="Google LLC", - author_email="googleapis-packages@google.com", - license="Apache 2.0", - url=url, - classifiers=[ - release_status, - "Intended Audience :: Developers", - "License :: OSI Approved :: Apache Software License", - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.7", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - namespace_packages=namespaces, - install_requires=dependencies, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/v2/testing/constraints-3.10.txt b/owl-bot-staging/v2/testing/constraints-3.10.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.10.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.11.txt b/owl-bot-staging/v2/testing/constraints-3.11.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.11.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.12.txt b/owl-bot-staging/v2/testing/constraints-3.12.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.12.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.7.txt b/owl-bot-staging/v2/testing/constraints-3.7.txt deleted file mode 100644 index 6c44adf..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.7.txt +++ /dev/null @@ -1,9 +0,0 @@ -# This constraints file is used to check that lower bounds -# are correct in setup.py -# List all library dependencies and extras in this file. -# Pin the version to the lower bound. -# e.g., if setup.py has "google-cloud-foo >= 1.14.0, < 2.0.0dev", -# Then this file should have google-cloud-foo==1.14.0 -google-api-core==1.34.0 -proto-plus==1.22.0 -protobuf==3.19.5 diff --git a/owl-bot-staging/v2/testing/constraints-3.8.txt b/owl-bot-staging/v2/testing/constraints-3.8.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.8.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/testing/constraints-3.9.txt b/owl-bot-staging/v2/testing/constraints-3.9.txt deleted file mode 100644 index ed7f9ae..0000000 --- a/owl-bot-staging/v2/testing/constraints-3.9.txt +++ /dev/null @@ -1,6 +0,0 @@ -# -*- coding: utf-8 -*- -# This constraints file is required for unit tests. -# List all library dependencies and extras in this file. -google-api-core -proto-plus -protobuf diff --git a/owl-bot-staging/v2/tests/__init__.py b/owl-bot-staging/v2/tests/__init__.py deleted file mode 100644 index 231bc12..0000000 --- a/owl-bot-staging/v2/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 231bc12..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2022 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 5058381..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_controller2.py +++ /dev/null @@ -1,2551 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -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,transport_name", [ - (Controller2Client, "grpc"), - (Controller2AsyncClient, "grpc_asyncio"), - (Controller2Client, "rest"), -]) -def test_controller2_client_from_service_account_info(client_class, transport_name): - 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, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.Controller2GrpcTransport, "grpc"), - (transports.Controller2GrpcAsyncIOTransport, "grpc_asyncio"), - (transports.Controller2RestTransport, "rest"), -]) -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,transport_name", [ - (Controller2Client, "grpc"), - (Controller2AsyncClient, "grpc_asyncio"), - (Controller2Client, "rest"), -]) -def test_controller2_client_from_service_account_file(client_class, transport_name): - 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", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -def test_controller2_client_get_transport_class(): - transport = Controller2Client.get_transport_class() - available_transports = [ - transports.Controller2GrpcTransport, - transports.Controller2RestTransport, - ] - 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"), - (Controller2Client, transports.Controller2RestTransport, "rest"), -]) -@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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - 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=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@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"), - (Controller2Client, transports.Controller2RestTransport, "rest", "true"), - (Controller2Client, transports.Controller2RestTransport, "rest", "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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - -@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"), - (Controller2Client, transports.Controller2RestTransport, "rest"), -]) -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, - api_audience=None, - ) - -@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), - (Controller2Client, transports.Controller2RestTransport, "rest", None), -]) -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, - api_audience=None, - ) - -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, - api_audience=None, - ) - - -@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, - api_audience=None, - ) - - # 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_field_headers(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.ListActiveBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # 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: - call.return_value = controller.ListActiveBreakpointsResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_active_breakpoints_field_headers_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.ListActiveBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # 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: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.ListActiveBreakpointsResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.UpdateActiveBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint.id = 'id_value' - - # 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: - call.return_value = controller.UpdateActiveBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_active_breakpoint_field_headers_async(): - client = Controller2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = controller.UpdateActiveBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint.id = 'id_value' - - # 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: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(controller.UpdateActiveBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint.id=id_value', - ) in kw['metadata'] - - -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'), - ) - - -@pytest.mark.parametrize("request_type", [ - controller.RegisterDebuggeeRequest, - dict, -]) -def test_register_debuggee_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.register_debuggee(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.RegisterDebuggeeResponse) - - -def test_register_debuggee_rest_required_fields(request_type=controller.RegisterDebuggeeRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).register_debuggee._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.register_debuggee(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_register_debuggee_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.register_debuggee._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("debuggee", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_register_debuggee_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_register_debuggee") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_register_debuggee") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.RegisterDebuggeeRequest.pb(controller.RegisterDebuggeeRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.RegisterDebuggeeResponse.to_json(controller.RegisterDebuggeeResponse()) - - request = controller.RegisterDebuggeeRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.RegisterDebuggeeResponse() - - client.register_debuggee(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_register_debuggee_rest_bad_request(transport: str = 'rest', request_type=controller.RegisterDebuggeeRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.register_debuggee(request) - - -def test_register_debuggee_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.RegisterDebuggeeResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {} - - # get truthy value for each flattened field - mock_args = dict( - debuggee=data.Debuggee(id='id_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.RegisterDebuggeeResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.register_debuggee(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/register" % client.transport._host, args[1]) - - -def test_register_debuggee_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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'), - ) - - -def test_register_debuggee_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - controller.ListActiveBreakpointsRequest, - dict, -]) -def test_list_active_breakpoints_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse( - next_wait_token='next_wait_token_value', - wait_expired=True, - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_active_breakpoints(request) - - # 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_rest_required_fields(request_type=controller.ListActiveBreakpointsRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_active_breakpoints._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("success_on_timeout", "wait_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_active_breakpoints(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_active_breakpoints_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_active_breakpoints._get_unset_required_fields({}) - assert set(unset_fields) == (set(("successOnTimeout", "waitToken", )) & set(("debuggeeId", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_active_breakpoints_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_list_active_breakpoints") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_list_active_breakpoints") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.ListActiveBreakpointsRequest.pb(controller.ListActiveBreakpointsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.ListActiveBreakpointsResponse.to_json(controller.ListActiveBreakpointsResponse()) - - request = controller.ListActiveBreakpointsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.ListActiveBreakpointsResponse() - - client.list_active_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_active_breakpoints_rest_bad_request(transport: str = 'rest', request_type=controller.ListActiveBreakpointsRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_active_breakpoints(request) - - -def test_list_active_breakpoints_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.ListActiveBreakpointsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.ListActiveBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_active_breakpoints(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) - - -def test_list_active_breakpoints_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_active_breakpoints_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - controller.UpdateActiveBreakpointRequest, - dict, -]) -def test_update_active_breakpoint_rest(request_type): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.update_active_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, controller.UpdateActiveBreakpointResponse) - - -def test_update_active_breakpoint_rest_required_fields(request_type=controller.UpdateActiveBreakpointRequest): - transport_class = transports.Controller2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_active_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "put", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.update_active_breakpoint(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_update_active_breakpoint_rest_unset_required_fields(): - transport = transports.Controller2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.update_active_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("debuggeeId", "breakpoint", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_active_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Controller2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Controller2RestInterceptor(), - ) - client = Controller2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Controller2RestInterceptor, "post_update_active_breakpoint") as post, \ - mock.patch.object(transports.Controller2RestInterceptor, "pre_update_active_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = controller.UpdateActiveBreakpointRequest.pb(controller.UpdateActiveBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = controller.UpdateActiveBreakpointResponse.to_json(controller.UpdateActiveBreakpointResponse()) - - request = controller.UpdateActiveBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = controller.UpdateActiveBreakpointResponse() - - client.update_active_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_update_active_breakpoint_rest_bad_request(transport: str = 'rest', request_type=controller.UpdateActiveBreakpointRequest): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.update_active_breakpoint(request) - - -def test_update_active_breakpoint_rest_flattened(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = controller.UpdateActiveBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_': {'id': 'sample2'}} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = controller.UpdateActiveBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.update_active_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/controller/debuggees/{debuggee_id}/breakpoints/{breakpoint_.id}" % client.transport._host, args[1]) - - -def test_update_active_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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'), - ) - - -def test_update_active_breakpoint_rest_error(): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -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, - transports.Controller2RestTransport, -]) -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() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = Controller2Client.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -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() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -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", - [ - transports.Controller2GrpcTransport, - transports.Controller2GrpcAsyncIOTransport, - transports.Controller2RestTransport, - ], -) -def test_controller2_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@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_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.Controller2RestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_controller2_host_no_port(transport_name): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_controller2_host_with_port(transport_name): - client = Controller2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_controller2_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = Controller2Client( - credentials=creds1, - transport=transport_name, - ) - client2 = Controller2Client( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.register_debuggee._session - session2 = client2.transport.register_debuggee._session - assert session1 != session2 - session1 = client1.transport.list_active_breakpoints._session - session2 = client2.transport.list_active_breakpoints._session - assert session1 != session2 - session1 = client1.transport.update_active_breakpoint._session - session2 = client2.transport.update_active_breakpoint._session - assert session1 != session2 -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 = { - "rest": "_session", - "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 = [ - 'rest', - '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, - api_audience=None, - ) 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 ad07b63..0000000 --- a/owl-bot-staging/v2/tests/unit/gapic/debugger_v2/test_debugger2.py +++ /dev/null @@ -1,3628 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2022 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 -# try/except added for compatibility with python < 3.8 -try: - from unittest import mock - from unittest.mock import AsyncMock # pragma: NO COVER -except ImportError: # pragma: NO COVER - import mock - -import grpc -from grpc.experimental import aio -from collections.abc import Iterable -from google.protobuf import json_format -import json -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule -from proto.marshal.rules import wrappers -from requests import Response -from requests import Request, PreparedRequest -from requests.sessions import Session -from google.protobuf import json_format - -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,transport_name", [ - (Debugger2Client, "grpc"), - (Debugger2AsyncClient, "grpc_asyncio"), - (Debugger2Client, "rest"), -]) -def test_debugger2_client_from_service_account_info(client_class, transport_name): - 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, transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.Debugger2GrpcTransport, "grpc"), - (transports.Debugger2GrpcAsyncIOTransport, "grpc_asyncio"), - (transports.Debugger2RestTransport, "rest"), -]) -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,transport_name", [ - (Debugger2Client, "grpc"), - (Debugger2AsyncClient, "grpc_asyncio"), - (Debugger2Client, "rest"), -]) -def test_debugger2_client_from_service_account_file(client_class, transport_name): - 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", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json", transport=transport_name) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://clouddebugger.googleapis.com' - ) - - -def test_debugger2_client_get_transport_class(): - transport = Debugger2Client.get_transport_class() - available_transports = [ - transports.Debugger2GrpcTransport, - transports.Debugger2RestTransport, - ] - 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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest"), -]) -@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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - # Check the case api_endpoint is provided - options = client_options.ClientOptions(api_audience="https://language.googleapis.com") - 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=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - always_use_jwt_access=True, - api_audience="https://language.googleapis.com" - ) - -@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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest", "true"), - (Debugger2Client, transports.Debugger2RestTransport, "rest", "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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - # 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, - api_audience=None, - ) - - -@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"), - (Debugger2Client, transports.Debugger2RestTransport, "rest"), -]) -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, - api_audience=None, - ) - -@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), - (Debugger2Client, transports.Debugger2RestTransport, "rest", None), -]) -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, - api_audience=None, - ) - -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, - api_audience=None, - ) - - -@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, - api_audience=None, - ) - - # 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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.SetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - call.return_value = debugger.SetBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_set_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.SetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.set_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.SetBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.GetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - call.return_value = debugger.GetBreakpointResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.GetBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.GetBreakpointResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.DeleteBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - call.return_value = None - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_breakpoint_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.DeleteBreakpointRequest() - - request.debuggee_id = 'debuggee_id_value' - request.breakpoint_id = 'breakpoint_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_breakpoint), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value&breakpoint_id=breakpoint_id_value', - ) in kw['metadata'] - - -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_field_headers(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.ListBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - call.return_value = debugger.ListBreakpointsResponse() - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_list_breakpoints_field_headers_async(): - client = Debugger2AsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Any value that is part of the HTTP/1.1 URI should be sent as - # a field header. Set these to a non-empty value. - request = debugger.ListBreakpointsRequest() - - request.debuggee_id = 'debuggee_id_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.list_breakpoints), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(debugger.ListBreakpointsResponse()) - 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] == request - - # Establish that the field header was sent. - _, _, kw = call.mock_calls[0] - assert ( - 'x-goog-request-params', - 'debuggee_id=debuggee_id_value', - ) in kw['metadata'] - - -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', - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.SetBreakpointRequest, - dict, -]) -def test_set_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.set_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.SetBreakpointResponse) - - -def test_set_breakpoint_rest_required_fields(request_type=debugger.SetBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).set_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("breakpoint_", "client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "post", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.set_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_set_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.set_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("breakpoint", "clientVersion", )) & set(("debuggeeId", "breakpoint", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_set_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_set_breakpoint") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_set_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.SetBreakpointRequest.pb(debugger.SetBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.SetBreakpointResponse.to_json(debugger.SetBreakpointResponse()) - - request = debugger.SetBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.SetBreakpointResponse() - - client.set_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_set_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.SetBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request_init["breakpoint_"] = {'id': 'id_value', 'action': 1, 'location': {'path': 'path_value', 'line': 424, 'column': 654}, 'condition': 'condition_value', 'expressions': ['expressions_value1', 'expressions_value2'], 'log_message_format': 'log_message_format_value', 'log_level': 1, 'is_final_state': True, 'create_time': {'seconds': 751, 'nanos': 543}, 'final_time': {}, 'user_email': 'user_email_value', 'status': {'is_error': True, 'refers_to': 3, 'description': {'format_': 'format__value', 'parameters': ['parameters_value1', 'parameters_value2']}}, 'stack_frames': [{'function': 'function_value', 'location': {}, 'arguments': [{'name': 'name_value', 'value': 'value_value', 'type_': 'type__value', 'members': {}, 'var_table_index': {'value': 541}, 'status': {}}], 'locals_': {}}], 'evaluated_expressions': {}, 'variable_table': {}, 'labels': {}} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.set_breakpoint(request) - - -def test_set_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.SetBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_=data.Breakpoint(id='id_value'), - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.SetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.set_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/set" % client.transport._host, args[1]) - - -def test_set_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_set_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.GetBreakpointRequest, - dict, -]) -def test_get_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.get_breakpoint(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.GetBreakpointResponse) - - -def test_get_breakpoint_rest_required_fields(request_type=debugger.GetBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["breakpoint_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["breakpointId"] = 'breakpoint_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "breakpointId" in jsonified_request - assert jsonified_request["breakpointId"] == 'breakpoint_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.get_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_get_breakpoint") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_get_breakpoint") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.GetBreakpointRequest.pb(debugger.GetBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.GetBreakpointResponse.to_json(debugger.GetBreakpointResponse()) - - request = debugger.GetBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.GetBreakpointResponse() - - client.get_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.GetBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.get_breakpoint(request) - - -def test_get_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.GetBreakpointResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.GetBreakpointResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.get_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) - - -def test_get_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_get_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.DeleteBreakpointRequest, - dict, -]) -def test_delete_breakpoint_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.delete_breakpoint(request) - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_breakpoint_rest_required_fields(request_type=debugger.DeleteBreakpointRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["breakpoint_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["breakpointId"] = 'breakpoint_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_breakpoint._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "breakpointId" in jsonified_request - assert jsonified_request["breakpointId"] == 'breakpoint_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = None - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "delete", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.delete_breakpoint(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_breakpoint_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_breakpoint._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", )) & set(("debuggeeId", "breakpointId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_breakpoint_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_delete_breakpoint") as pre: - pre.assert_not_called() - pb_message = debugger.DeleteBreakpointRequest.pb(debugger.DeleteBreakpointRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - - request = debugger.DeleteBreakpointRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.delete_breakpoint(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_delete_breakpoint_rest_bad_request(transport: str = 'rest', request_type=debugger.DeleteBreakpointRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.delete_breakpoint(request) - - -def test_delete_breakpoint_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = None - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1', 'breakpoint_id': 'sample2'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - breakpoint_id='breakpoint_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - json_return_value = '' - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.delete_breakpoint(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints/{breakpoint_id}" % client.transport._host, args[1]) - - -def test_delete_breakpoint_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_delete_breakpoint_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.ListBreakpointsRequest, - dict, -]) -def test_list_breakpoints_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse( - next_wait_token='next_wait_token_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_breakpoints(request) - - # 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_rest_required_fields(request_type=debugger.ListBreakpointsRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["debuggee_id"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["debuggeeId"] = 'debuggee_id_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_breakpoints._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("action", "client_version", "include_all_users", "include_inactive", "strip_results", "wait_token", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "debuggeeId" in jsonified_request - assert jsonified_request["debuggeeId"] == 'debuggee_id_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_breakpoints(request) - - expected_params = [ - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_breakpoints_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_breakpoints._get_unset_required_fields({}) - assert set(unset_fields) == (set(("action", "clientVersion", "includeAllUsers", "includeInactive", "stripResults", "waitToken", )) & set(("debuggeeId", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_breakpoints_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_list_breakpoints") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_breakpoints") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.ListBreakpointsRequest.pb(debugger.ListBreakpointsRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.ListBreakpointsResponse.to_json(debugger.ListBreakpointsResponse()) - - request = debugger.ListBreakpointsRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.ListBreakpointsResponse() - - client.list_breakpoints(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_breakpoints_rest_bad_request(transport: str = 'rest', request_type=debugger.ListBreakpointsRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'debuggee_id': 'sample1'} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_breakpoints(request) - - -def test_list_breakpoints_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListBreakpointsResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'debuggee_id': 'sample1'} - - # get truthy value for each flattened field - mock_args = dict( - debuggee_id='debuggee_id_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListBreakpointsResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_breakpoints(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees/{debuggee_id}/breakpoints" % client.transport._host, args[1]) - - -def test_list_breakpoints_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_breakpoints_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - debugger.ListDebuggeesRequest, - dict, -]) -def test_list_debuggees_rest(request_type): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse( - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.list_debuggees(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, debugger.ListDebuggeesResponse) - - -def test_list_debuggees_rest_required_fields(request_type=debugger.ListDebuggeesRequest): - transport_class = transports.Debugger2RestTransport - - request_init = {} - request_init["project"] = "" - request_init["client_version"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - including_default_value_fields=False, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - assert "project" not in jsonified_request - assert "clientVersion" not in jsonified_request - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - assert "project" in jsonified_request - assert jsonified_request["project"] == request_init["project"] - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == request_init["client_version"] - - jsonified_request["project"] = 'project_value' - jsonified_request["clientVersion"] = 'client_version_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).list_debuggees._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("client_version", "include_inactive", "project", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "project" in jsonified_request - assert jsonified_request["project"] == 'project_value' - assert "clientVersion" in jsonified_request - assert jsonified_request["clientVersion"] == 'client_version_value' - - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse() - # Mock the http request call within the method and fake a response. - with mock.patch.object(Session, 'request') as req: - # We need to mock transcode() because providing default values - # for required fields will fail the real version if the http_options - # expect actual values for those fields. - with mock.patch.object(path_template, 'transcode') as transcode: - # A uri without fields and an empty body will force all the - # request fields to show up in the query_params. - pb_request = request_type.pb(request) - transcode_result = { - 'uri': 'v1/sample_method', - 'method': "get", - 'query_params': pb_request, - } - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.list_debuggees(request) - - expected_params = [ - ( - "project", - "", - ), - ( - "clientVersion", - "", - ), - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_list_debuggees_rest_unset_required_fields(): - transport = transports.Debugger2RestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.list_debuggees._get_unset_required_fields({}) - assert set(unset_fields) == (set(("clientVersion", "includeInactive", "project", )) & set(("project", "clientVersion", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_list_debuggees_rest_interceptors(null_interceptor): - transport = transports.Debugger2RestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.Debugger2RestInterceptor(), - ) - client = Debugger2Client(transport=transport) - with mock.patch.object(type(client.transport._session), "request") as req, \ - mock.patch.object(path_template, "transcode") as transcode, \ - mock.patch.object(transports.Debugger2RestInterceptor, "post_list_debuggees") as post, \ - mock.patch.object(transports.Debugger2RestInterceptor, "pre_list_debuggees") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = debugger.ListDebuggeesRequest.pb(debugger.ListDebuggeesRequest()) - transcode.return_value = { - "method": "post", - "uri": "my_uri", - "body": pb_message, - "query_params": pb_message, - } - - req.return_value = Response() - req.return_value.status_code = 200 - req.return_value.request = PreparedRequest() - req.return_value._content = debugger.ListDebuggeesResponse.to_json(debugger.ListDebuggeesResponse()) - - request = debugger.ListDebuggeesRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = debugger.ListDebuggeesResponse() - - client.list_debuggees(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_list_debuggees_rest_bad_request(transport: str = 'rest', request_type=debugger.ListDebuggeesRequest): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {} - request = request_type(**request_init) - - # Mock the http request call within the method and fake a BadRequest error. - with mock.patch.object(Session, 'request') as req, pytest.raises(core_exceptions.BadRequest): - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 400 - response_value.request = Request() - req.return_value = response_value - client.list_debuggees(request) - - -def test_list_debuggees_rest_flattened(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Mock the http request call within the method and fake a response. - with mock.patch.object(type(client.transport._session), 'request') as req: - # Designate an appropriate value for the returned response. - return_value = debugger.ListDebuggeesResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {} - - # get truthy value for each flattened field - mock_args = dict( - project='project_value', - client_version='client_version_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - pb_return_value = debugger.ListDebuggeesResponse.pb(return_value) - json_return_value = json_format.MessageToJson(pb_return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.list_debuggees(**mock_args) - - # Establish that the underlying call was made with the expected - # request object values. - assert len(req.mock_calls) == 1 - _, args, _ = req.mock_calls[0] - assert path_template.validate("%s/v2/debugger/debuggees" % client.transport._host, args[1]) - - -def test_list_debuggees_rest_flattened_error(transport: str = 'rest'): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # 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', - ) - - -def test_list_debuggees_rest_error(): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -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, - transports.Debugger2RestTransport, -]) -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() - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "rest", -]) -def test_transport_kind(transport_name): - transport = Debugger2Client.get_transport_class(transport_name)( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert transport.kind == transport_name - -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() - - # Catch all for all remaining methods and properties - remainder = [ - 'kind', - ] - for r in remainder: - with pytest.raises(NotImplementedError): - getattr(transport, r)() - - -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", - [ - transports.Debugger2GrpcTransport, - transports.Debugger2GrpcAsyncIOTransport, - transports.Debugger2RestTransport, - ], -) -def test_debugger2_transport_auth_gdch_credentials(transport_class): - host = 'https://language.com' - api_audience_tests = [None, 'https://language2.com'] - api_audience_expect = [host, 'https://language2.com'] - for t, e in zip(api_audience_tests, api_audience_expect): - with mock.patch.object(google.auth, 'default', autospec=True) as adc: - gdch_mock = mock.MagicMock() - type(gdch_mock).with_gdch_audience = mock.PropertyMock(return_value=gdch_mock) - adc.return_value = (gdch_mock, None) - transport_class(host=host, api_audience=t) - gdch_mock.with_gdch_audience.assert_called_once_with( - e - ) - - -@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_http_transport_client_cert_source_for_mtls(): - cred = ga_credentials.AnonymousCredentials() - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel") as mock_configure_mtls_channel: - transports.Debugger2RestTransport ( - credentials=cred, - client_cert_source_for_mtls=client_cert_source_callback - ) - mock_configure_mtls_channel.assert_called_once_with(client_cert_source_callback) - - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_debugger2_host_no_port(transport_name): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_debugger2_host_with_port(transport_name): - client = Debugger2Client( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='clouddebugger.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'clouddebugger.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://clouddebugger.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_debugger2_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = Debugger2Client( - credentials=creds1, - transport=transport_name, - ) - client2 = Debugger2Client( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.set_breakpoint._session - session2 = client2.transport.set_breakpoint._session - assert session1 != session2 - session1 = client1.transport.get_breakpoint._session - session2 = client2.transport.get_breakpoint._session - assert session1 != session2 - session1 = client1.transport.delete_breakpoint._session - session2 = client2.transport.delete_breakpoint._session - assert session1 != session2 - session1 = client1.transport.list_breakpoints._session - session2 = client2.transport.list_breakpoints._session - assert session1 != session2 - session1 = client1.transport.list_debuggees._session - session2 = client2.transport.list_debuggees._session - assert session1 != session2 -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 = { - "rest": "_session", - "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 = [ - 'rest', - '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, - api_audience=None, - )