From 7d0fd7943a537c3bf7b3cd64f7e010bcf6fc072d Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Tue, 25 Jun 2024 01:54:47 +0000 Subject: [PATCH 1/2] docs: A comment for field `parent` in message `.google.cloud.oslogin.v1beta.SignSshPublicKeyRequest` is changed PiperOrigin-RevId: 646243563 Source-Link: https://github.com/googleapis/googleapis/commit/e4e39feea63b5f0d646fc193acbf536b5d292b64 Source-Link: https://github.com/googleapis/googleapis-gen/commit/09e7fc1a04f6f615ba076e2aed5abb714b8a3b97 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLW9zLWxvZ2luLy5Pd2xCb3QueWFtbCIsImgiOiIwOWU3ZmMxYTA0ZjZmNjE1YmEwNzZlMmFlZDVhYmI3MTRiOGEzYjk3In0= --- .../google-cloud-os-login/v1/.coveragerc | 13 + .../google-cloud-os-login/v1/.flake8 | 33 + .../google-cloud-os-login/v1/MANIFEST.in | 2 + .../google-cloud-os-login/v1/README.rst | 49 + .../v1/docs/_static/custom.css | 3 + .../google-cloud-os-login/v1/docs/conf.py | 376 + .../google-cloud-os-login/v1/docs/index.rst | 7 + .../v1/docs/oslogin_v1/os_login_service.rst | 6 + .../v1/docs/oslogin_v1/services_.rst | 6 + .../v1/docs/oslogin_v1/types_.rst | 6 + .../v1/google/cloud/oslogin/__init__.py | 45 + .../v1/google/cloud/oslogin/gapic_version.py | 16 + .../v1/google/cloud/oslogin/py.typed | 2 + .../v1/google/cloud/oslogin_v1/__init__.py | 46 + .../cloud/oslogin_v1/gapic_metadata.json | 133 + .../google/cloud/oslogin_v1/gapic_version.py | 16 + .../v1/google/cloud/oslogin_v1/py.typed | 2 + .../cloud/oslogin_v1/services/__init__.py | 15 + .../services/os_login_service/__init__.py | 22 + .../services/os_login_service/async_client.py | 1008 +++ .../services/os_login_service/client.py | 1366 ++++ .../os_login_service/transports/__init__.py | 38 + .../os_login_service/transports/base.py | 301 + .../os_login_service/transports/grpc.py | 436 ++ .../transports/grpc_asyncio.py | 536 ++ .../os_login_service/transports/rest.py | 941 +++ .../google/cloud/oslogin_v1/types/__init__.py | 38 + .../google/cloud/oslogin_v1/types/oslogin.py | 271 + .../google-cloud-os-login/v1/mypy.ini | 3 + .../google-cloud-os-login/v1/noxfile.py | 253 + ...gin_service_create_ssh_public_key_async.py | 52 + ...ogin_service_create_ssh_public_key_sync.py | 52 + ...ogin_service_delete_posix_account_async.py | 50 + ...login_service_delete_posix_account_sync.py | 50 + ...gin_service_delete_ssh_public_key_async.py | 50 + ...ogin_service_delete_ssh_public_key_sync.py | 50 + ...s_login_service_get_login_profile_async.py | 52 + ...os_login_service_get_login_profile_sync.py | 52 + ..._login_service_get_ssh_public_key_async.py | 52 + ...s_login_service_get_ssh_public_key_sync.py | 52 + ...gin_service_import_ssh_public_key_async.py | 52 + ...ogin_service_import_ssh_public_key_sync.py | 52 + ...gin_service_update_ssh_public_key_async.py | 52 + ...ogin_service_update_ssh_public_key_sync.py | 52 + ...ppet_metadata_google.cloud.oslogin.v1.json | 1170 ++++ .../v1/scripts/fixup_oslogin_v1_keywords.py | 182 + .../google-cloud-os-login/v1/setup.py | 93 + .../v1/testing/constraints-3.10.txt | 6 + .../v1/testing/constraints-3.11.txt | 6 + .../v1/testing/constraints-3.12.txt | 6 + .../v1/testing/constraints-3.7.txt | 10 + .../v1/testing/constraints-3.8.txt | 6 + .../v1/testing/constraints-3.9.txt | 6 + .../v1/tests/__init__.py | 16 + .../v1/tests/unit/__init__.py | 16 + .../v1/tests/unit/gapic/__init__.py | 16 + .../tests/unit/gapic/oslogin_v1/__init__.py | 16 + .../gapic/oslogin_v1/test_os_login_service.py | 6129 +++++++++++++++++ 58 files changed, 14387 insertions(+) create mode 100644 owl-bot-staging/google-cloud-os-login/v1/.coveragerc create mode 100644 owl-bot-staging/google-cloud-os-login/v1/.flake8 create mode 100644 owl-bot-staging/google-cloud-os-login/v1/MANIFEST.in create mode 100644 owl-bot-staging/google-cloud-os-login/v1/README.rst create mode 100644 owl-bot-staging/google-cloud-os-login/v1/docs/_static/custom.css create mode 100644 owl-bot-staging/google-cloud-os-login/v1/docs/conf.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/docs/index.rst create mode 100644 owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/os_login_service.rst create mode 100644 owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/services_.rst create mode 100644 owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/types_.rst create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/__init__.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/gapic_version.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/py.typed create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/__init__.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_metadata.json create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_version.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/py.typed create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/__init__.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/client.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/rest.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/__init__.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/oslogin.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/mypy.ini create mode 100644 owl-bot-staging/google-cloud-os-login/v1/noxfile.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_async.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_sync.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_async.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_sync.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_async.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_sync.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_async.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_sync.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_async.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_sync.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_async.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_sync.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_async.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_sync.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/snippet_metadata_google.cloud.oslogin.v1.json create mode 100644 owl-bot-staging/google-cloud-os-login/v1/scripts/fixup_oslogin_v1_keywords.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/setup.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.10.txt create mode 100644 owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.11.txt create mode 100644 owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.12.txt create mode 100644 owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.7.txt create mode 100644 owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.8.txt create mode 100644 owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.9.txt create mode 100644 owl-bot-staging/google-cloud-os-login/v1/tests/__init__.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/tests/unit/__init__.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/__init__.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/__init__.py create mode 100644 owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py diff --git a/owl-bot-staging/google-cloud-os-login/v1/.coveragerc b/owl-bot-staging/google-cloud-os-login/v1/.coveragerc new file mode 100644 index 000000000000..5de532f89801 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/.coveragerc @@ -0,0 +1,13 @@ +[run] +branch = True + +[report] +show_missing = True +omit = + google/cloud/oslogin/__init__.py + google/cloud/oslogin/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/google-cloud-os-login/v1/.flake8 b/owl-bot-staging/google-cloud-os-login/v1/.flake8 new file mode 100644 index 000000000000..29227d4cf419 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/.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/google-cloud-os-login/v1/MANIFEST.in b/owl-bot-staging/google-cloud-os-login/v1/MANIFEST.in new file mode 100644 index 000000000000..855fae674325 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/oslogin *.py +recursive-include google/cloud/oslogin_v1 *.py diff --git a/owl-bot-staging/google-cloud-os-login/v1/README.rst b/owl-bot-staging/google-cloud-os-login/v1/README.rst new file mode 100644 index 000000000000..db2bd84ed7e1 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Oslogin 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 Oslogin 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/google-cloud-os-login/v1/docs/_static/custom.css b/owl-bot-staging/google-cloud-os-login/v1/docs/_static/custom.css new file mode 100644 index 000000000000..06423be0b592 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/docs/_static/custom.css @@ -0,0 +1,3 @@ +dl.field-list > dt { + min-width: 100px +} diff --git a/owl-bot-staging/google-cloud-os-login/v1/docs/conf.py b/owl-bot-staging/google-cloud-os-login/v1/docs/conf.py new file mode 100644 index 000000000000..0187fbfa0cd1 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/docs/conf.py @@ -0,0 +1,376 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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-os-login 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-os-login" +copyright = u"2023, 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 = 'en' + +# 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-os-login-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-os-login.tex", + u"google-cloud-os-login 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-os-login", + u"Google Cloud Oslogin 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-os-login", + u"google-cloud-os-login Documentation", + author, + "google-cloud-os-login", + "GAPIC library for Google Cloud Oslogin 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/google-cloud-os-login/v1/docs/index.rst b/owl-bot-staging/google-cloud-os-login/v1/docs/index.rst new file mode 100644 index 000000000000..76e15ba81fe8 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + oslogin_v1/services + oslogin_v1/types diff --git a/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/os_login_service.rst b/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/os_login_service.rst new file mode 100644 index 000000000000..588b1fb7b214 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/os_login_service.rst @@ -0,0 +1,6 @@ +OsLoginService +-------------------------------- + +.. automodule:: google.cloud.oslogin_v1.services.os_login_service + :members: + :inherited-members: diff --git a/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/services_.rst b/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/services_.rst new file mode 100644 index 000000000000..10a71557c528 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/services_.rst @@ -0,0 +1,6 @@ +Services for Google Cloud Oslogin v1 API +======================================== +.. toctree:: + :maxdepth: 2 + + os_login_service diff --git a/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/types_.rst b/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/types_.rst new file mode 100644 index 000000000000..ad7f7feaff01 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/types_.rst @@ -0,0 +1,6 @@ +Types for Google Cloud Oslogin v1 API +===================================== + +.. automodule:: google.cloud.oslogin_v1.types + :members: + :show-inheritance: diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/__init__.py new file mode 100644 index 000000000000..70e2899cea16 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/__init__.py @@ -0,0 +1,45 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.oslogin import gapic_version as package_version + +__version__ = package_version.__version__ + + +from google.cloud.oslogin_v1.services.os_login_service.client import OsLoginServiceClient +from google.cloud.oslogin_v1.services.os_login_service.async_client import OsLoginServiceAsyncClient + +from google.cloud.oslogin_v1.types.oslogin import CreateSshPublicKeyRequest +from google.cloud.oslogin_v1.types.oslogin import DeletePosixAccountRequest +from google.cloud.oslogin_v1.types.oslogin import DeleteSshPublicKeyRequest +from google.cloud.oslogin_v1.types.oslogin import GetLoginProfileRequest +from google.cloud.oslogin_v1.types.oslogin import GetSshPublicKeyRequest +from google.cloud.oslogin_v1.types.oslogin import ImportSshPublicKeyRequest +from google.cloud.oslogin_v1.types.oslogin import ImportSshPublicKeyResponse +from google.cloud.oslogin_v1.types.oslogin import LoginProfile +from google.cloud.oslogin_v1.types.oslogin import UpdateSshPublicKeyRequest + +__all__ = ('OsLoginServiceClient', + 'OsLoginServiceAsyncClient', + 'CreateSshPublicKeyRequest', + 'DeletePosixAccountRequest', + 'DeleteSshPublicKeyRequest', + 'GetLoginProfileRequest', + 'GetSshPublicKeyRequest', + 'ImportSshPublicKeyRequest', + 'ImportSshPublicKeyResponse', + 'LoginProfile', + 'UpdateSshPublicKeyRequest', +) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/gapic_version.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/gapic_version.py new file mode 100644 index 000000000000..558c8aab67c5 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/google-cloud-os-login/v1/google/cloud/oslogin/py.typed b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/py.typed new file mode 100644 index 000000000000..1a80e6c43390 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-os-login package uses inline types. diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/__init__.py new file mode 100644 index 000000000000..fbaca75ec964 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/__init__.py @@ -0,0 +1,46 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.oslogin_v1 import gapic_version as package_version + +__version__ = package_version.__version__ + + +from .services.os_login_service import OsLoginServiceClient +from .services.os_login_service import OsLoginServiceAsyncClient + +from .types.oslogin import CreateSshPublicKeyRequest +from .types.oslogin import DeletePosixAccountRequest +from .types.oslogin import DeleteSshPublicKeyRequest +from .types.oslogin import GetLoginProfileRequest +from .types.oslogin import GetSshPublicKeyRequest +from .types.oslogin import ImportSshPublicKeyRequest +from .types.oslogin import ImportSshPublicKeyResponse +from .types.oslogin import LoginProfile +from .types.oslogin import UpdateSshPublicKeyRequest + +__all__ = ( + 'OsLoginServiceAsyncClient', +'CreateSshPublicKeyRequest', +'DeletePosixAccountRequest', +'DeleteSshPublicKeyRequest', +'GetLoginProfileRequest', +'GetSshPublicKeyRequest', +'ImportSshPublicKeyRequest', +'ImportSshPublicKeyResponse', +'LoginProfile', +'OsLoginServiceClient', +'UpdateSshPublicKeyRequest', +) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_metadata.json b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_metadata.json new file mode 100644 index 000000000000..61118fd98b22 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_metadata.json @@ -0,0 +1,133 @@ + { + "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", + "language": "python", + "libraryPackage": "google.cloud.oslogin_v1", + "protoPackage": "google.cloud.oslogin.v1", + "schema": "1.0", + "services": { + "OsLoginService": { + "clients": { + "grpc": { + "libraryClient": "OsLoginServiceClient", + "rpcs": { + "CreateSshPublicKey": { + "methods": [ + "create_ssh_public_key" + ] + }, + "DeletePosixAccount": { + "methods": [ + "delete_posix_account" + ] + }, + "DeleteSshPublicKey": { + "methods": [ + "delete_ssh_public_key" + ] + }, + "GetLoginProfile": { + "methods": [ + "get_login_profile" + ] + }, + "GetSshPublicKey": { + "methods": [ + "get_ssh_public_key" + ] + }, + "ImportSshPublicKey": { + "methods": [ + "import_ssh_public_key" + ] + }, + "UpdateSshPublicKey": { + "methods": [ + "update_ssh_public_key" + ] + } + } + }, + "grpc-async": { + "libraryClient": "OsLoginServiceAsyncClient", + "rpcs": { + "CreateSshPublicKey": { + "methods": [ + "create_ssh_public_key" + ] + }, + "DeletePosixAccount": { + "methods": [ + "delete_posix_account" + ] + }, + "DeleteSshPublicKey": { + "methods": [ + "delete_ssh_public_key" + ] + }, + "GetLoginProfile": { + "methods": [ + "get_login_profile" + ] + }, + "GetSshPublicKey": { + "methods": [ + "get_ssh_public_key" + ] + }, + "ImportSshPublicKey": { + "methods": [ + "import_ssh_public_key" + ] + }, + "UpdateSshPublicKey": { + "methods": [ + "update_ssh_public_key" + ] + } + } + }, + "rest": { + "libraryClient": "OsLoginServiceClient", + "rpcs": { + "CreateSshPublicKey": { + "methods": [ + "create_ssh_public_key" + ] + }, + "DeletePosixAccount": { + "methods": [ + "delete_posix_account" + ] + }, + "DeleteSshPublicKey": { + "methods": [ + "delete_ssh_public_key" + ] + }, + "GetLoginProfile": { + "methods": [ + "get_login_profile" + ] + }, + "GetSshPublicKey": { + "methods": [ + "get_ssh_public_key" + ] + }, + "ImportSshPublicKey": { + "methods": [ + "import_ssh_public_key" + ] + }, + "UpdateSshPublicKey": { + "methods": [ + "update_ssh_public_key" + ] + } + } + } + } + } + } +} diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_version.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_version.py new file mode 100644 index 000000000000..558c8aab67c5 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_version.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/google-cloud-os-login/v1/google/cloud/oslogin_v1/py.typed b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/py.typed new file mode 100644 index 000000000000..1a80e6c43390 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-os-login package uses inline types. diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/__init__.py new file mode 100644 index 000000000000..8f6cf068242c --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/__init__.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py new file mode 100644 index 000000000000..347571e25212 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 OsLoginServiceClient +from .async_client import OsLoginServiceAsyncClient + +__all__ = ( + 'OsLoginServiceClient', + 'OsLoginServiceAsyncClient', +) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py new file mode 100644 index 000000000000..37ff0a733d44 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py @@ -0,0 +1,1008 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union + +from google.cloud.oslogin_v1 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_async as retries +from google.auth import credentials as ga_credentials # type: ignore +from google.oauth2 import service_account # type: ignore + + +try: + OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore + +from google.cloud.oslogin.common.types import common +from google.cloud.oslogin_v1.types import oslogin +from google.protobuf import field_mask_pb2 # type: ignore +from .transports.base import OsLoginServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc_asyncio import OsLoginServiceGrpcAsyncIOTransport +from .client import OsLoginServiceClient + + +class OsLoginServiceAsyncClient: + """Cloud OS Login API + + The Cloud OS Login API allows you to manage users and their + associated SSH public keys for logging into virtual machines on + Google Cloud Platform. + """ + + _client: OsLoginServiceClient + + # Copy defaults from the synchronous client for use here. + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = OsLoginServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = OsLoginServiceClient.DEFAULT_MTLS_ENDPOINT + _DEFAULT_ENDPOINT_TEMPLATE = OsLoginServiceClient._DEFAULT_ENDPOINT_TEMPLATE + _DEFAULT_UNIVERSE = OsLoginServiceClient._DEFAULT_UNIVERSE + + posix_account_path = staticmethod(OsLoginServiceClient.posix_account_path) + parse_posix_account_path = staticmethod(OsLoginServiceClient.parse_posix_account_path) + ssh_public_key_path = staticmethod(OsLoginServiceClient.ssh_public_key_path) + parse_ssh_public_key_path = staticmethod(OsLoginServiceClient.parse_ssh_public_key_path) + common_billing_account_path = staticmethod(OsLoginServiceClient.common_billing_account_path) + parse_common_billing_account_path = staticmethod(OsLoginServiceClient.parse_common_billing_account_path) + common_folder_path = staticmethod(OsLoginServiceClient.common_folder_path) + parse_common_folder_path = staticmethod(OsLoginServiceClient.parse_common_folder_path) + common_organization_path = staticmethod(OsLoginServiceClient.common_organization_path) + parse_common_organization_path = staticmethod(OsLoginServiceClient.parse_common_organization_path) + common_project_path = staticmethod(OsLoginServiceClient.common_project_path) + parse_common_project_path = staticmethod(OsLoginServiceClient.parse_common_project_path) + common_location_path = staticmethod(OsLoginServiceClient.common_location_path) + parse_common_location_path = staticmethod(OsLoginServiceClient.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: + OsLoginServiceAsyncClient: The constructed client. + """ + return OsLoginServiceClient.from_service_account_info.__func__(OsLoginServiceAsyncClient, 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: + OsLoginServiceAsyncClient: The constructed client. + """ + return OsLoginServiceClient.from_service_account_file.__func__(OsLoginServiceAsyncClient, 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 OsLoginServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore + + @property + def transport(self) -> OsLoginServiceTransport: + """Returns the transport used by the client instance. + + Returns: + OsLoginServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._client._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used + by the client instance. + """ + return self._client._universe_domain + + get_transport_class = functools.partial(type(OsLoginServiceClient).get_transport_class, type(OsLoginServiceClient)) + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, OsLoginServiceTransport, Callable[..., OsLoginServiceTransport]]] = "grpc_asyncio", + client_options: Optional[ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the os login service async 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 (Optional[Union[str,OsLoginServiceTransport,Callable[..., OsLoginServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport to use. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the OsLoginServiceTransport constructor. + 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. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "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). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS 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. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + 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. + """ + self._client = OsLoginServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def create_ssh_public_key(self, + request: Optional[Union[oslogin.CreateSshPublicKeyRequest, dict]] = None, + *, + parent: Optional[str] = None, + ssh_public_key: Optional[common.SshPublicKey] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> common.SshPublicKey: + r"""Create an SSH public key + + .. 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 oslogin_v1 + + async def sample_create_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.CreateSshPublicKeyRequest( + parent="parent_value", + ) + + # Make the request + response = await client.create_ssh_public_key(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.oslogin_v1.types.CreateSshPublicKeyRequest, dict]]): + The request object. A request message for creating an SSH + public key. + parent (:class:`str`): + Required. The unique ID for the user in format + ``users/{user}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + ssh_public_key (:class:`google.cloud.oslogin.common.types.SshPublicKey`): + Required. The SSH public key and + expiration time. + + This corresponds to the ``ssh_public_key`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be 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.oslogin.common.types.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + # 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([parent, ssh_public_key]) + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.CreateSshPublicKeyRequest): + request = oslogin.CreateSshPublicKeyRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if ssh_public_key is not None: + request.ssh_public_key = ssh_public_key + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.create_ssh_public_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def delete_posix_account(self, + request: Optional[Union[oslogin.DeletePosixAccountRequest, dict]] = None, + *, + name: 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 a POSIX account. + + .. 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 oslogin_v1 + + async def sample_delete_posix_account(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.DeletePosixAccountRequest( + name="name_value", + ) + + # Make the request + await client.delete_posix_account(request=request) + + Args: + request (Optional[Union[google.cloud.oslogin_v1.types.DeletePosixAccountRequest, dict]]): + The request object. A request message for deleting a + POSIX account entry. + name (:class:`str`): + Required. A reference to the POSIX account to update. + POSIX accounts are identified by the project ID they are + associated with. A reference to the POSIX account is in + format ``users/{user}/projects/{project}``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be 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([name]) + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.DeletePosixAccountRequest): + request = oslogin.DeletePosixAccountRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.delete_posix_account] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def delete_ssh_public_key(self, + request: Optional[Union[oslogin.DeleteSshPublicKeyRequest, dict]] = None, + *, + name: 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 an SSH public key. + + .. 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 oslogin_v1 + + async def sample_delete_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.DeleteSshPublicKeyRequest( + name="name_value", + ) + + # Make the request + await client.delete_ssh_public_key(request=request) + + Args: + request (Optional[Union[google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest, dict]]): + The request object. A request message for deleting an SSH + public key. + name (:class:`str`): + Required. The fingerprint of the public key to update. + Public keys are identified by their SHA-256 fingerprint. + The fingerprint of the public key is in format + ``users/{user}/sshPublicKeys/{fingerprint}``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be 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([name]) + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.DeleteSshPublicKeyRequest): + request = oslogin.DeleteSshPublicKeyRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.delete_ssh_public_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def get_login_profile(self, + request: Optional[Union[oslogin.GetLoginProfileRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> oslogin.LoginProfile: + r"""Retrieves the profile information used for logging in + to a virtual machine on Google Compute Engine. + + .. 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 oslogin_v1 + + async def sample_get_login_profile(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.GetLoginProfileRequest( + name="name_value", + ) + + # Make the request + response = await client.get_login_profile(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.oslogin_v1.types.GetLoginProfileRequest, dict]]): + The request object. A request message for retrieving the + login profile information for a user. + name (:class:`str`): + Required. The unique ID for the user in format + ``users/{user}``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be 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.oslogin_v1.types.LoginProfile: + The user profile information used for + logging in to a virtual machine on + Google Compute Engine. + + """ + # 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([name]) + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.GetLoginProfileRequest): + request = oslogin.GetLoginProfileRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.get_login_profile] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def get_ssh_public_key(self, + request: Optional[Union[oslogin.GetSshPublicKeyRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> common.SshPublicKey: + r"""Retrieves an SSH public key. + + .. 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 oslogin_v1 + + async def sample_get_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.GetSshPublicKeyRequest( + name="name_value", + ) + + # Make the request + response = await client.get_ssh_public_key(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.oslogin_v1.types.GetSshPublicKeyRequest, dict]]): + The request object. A request message for retrieving an + SSH public key. + name (:class:`str`): + Required. The fingerprint of the public key to retrieve. + Public keys are identified by their SHA-256 fingerprint. + The fingerprint of the public key is in format + ``users/{user}/sshPublicKeys/{fingerprint}``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be 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.oslogin.common.types.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + # 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([name]) + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.GetSshPublicKeyRequest): + request = oslogin.GetSshPublicKeyRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.get_ssh_public_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def import_ssh_public_key(self, + request: Optional[Union[oslogin.ImportSshPublicKeyRequest, dict]] = None, + *, + parent: Optional[str] = None, + ssh_public_key: Optional[common.SshPublicKey] = None, + project_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> oslogin.ImportSshPublicKeyResponse: + r"""Adds an SSH public key and returns the profile + information. Default POSIX account information is set + when no username and UID exist as part of the login + profile. + + .. 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 oslogin_v1 + + async def sample_import_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.ImportSshPublicKeyRequest( + parent="parent_value", + ) + + # Make the request + response = await client.import_ssh_public_key(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest, dict]]): + The request object. A request message for importing an + SSH public key. + parent (:class:`str`): + Required. The unique ID for the user in format + ``users/{user}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + ssh_public_key (:class:`google.cloud.oslogin.common.types.SshPublicKey`): + Optional. The SSH public key and + expiration time. + + This corresponds to the ``ssh_public_key`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + project_id (:class:`str`): + The project ID of the Google Cloud + Platform project. + + This corresponds to the ``project_id`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be 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.oslogin_v1.types.ImportSshPublicKeyResponse: + A response message for importing an + SSH public key. + + """ + # 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([parent, ssh_public_key, project_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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.ImportSshPublicKeyRequest): + request = oslogin.ImportSshPublicKeyRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if ssh_public_key is not None: + request.ssh_public_key = ssh_public_key + if project_id is not None: + request.project_id = project_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.import_ssh_public_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def update_ssh_public_key(self, + request: Optional[Union[oslogin.UpdateSshPublicKeyRequest, dict]] = None, + *, + name: Optional[str] = None, + ssh_public_key: Optional[common.SshPublicKey] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> common.SshPublicKey: + r"""Updates an SSH public key and returns the profile + information. This method supports patch semantics. + + .. 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 oslogin_v1 + + async def sample_update_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.UpdateSshPublicKeyRequest( + name="name_value", + ) + + # Make the request + response = await client.update_ssh_public_key(request=request) + + # Handle the response + print(response) + + Args: + request (Optional[Union[google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest, dict]]): + The request object. A request message for updating an SSH + public key. + name (:class:`str`): + Required. The fingerprint of the public key to update. + Public keys are identified by their SHA-256 fingerprint. + The fingerprint of the public key is in format + ``users/{user}/sshPublicKeys/{fingerprint}``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + ssh_public_key (:class:`google.cloud.oslogin.common.types.SshPublicKey`): + Required. The SSH public key and + expiration time. + + This corresponds to the ``ssh_public_key`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): + Mask to control which fields get + updated. Updates all if not present. + + This corresponds to the ``update_mask`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, + should be 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.oslogin.common.types.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + # 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([name, ssh_public_key, update_mask]) + 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.") + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.UpdateSshPublicKeyRequest): + request = oslogin.UpdateSshPublicKeyRequest(request) + + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if ssh_public_key is not None: + request.ssh_public_key = ssh_public_key + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._client._transport._wrapped_methods[self._client._transport.update_ssh_public_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Validate the universe domain. + self._client._validate_universe_domain() + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + async def __aenter__(self) -> "OsLoginServiceAsyncClient": + 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__ = ( + "OsLoginServiceAsyncClient", +) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/client.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/client.py new file mode 100644 index 000000000000..8a1295701604 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/client.py @@ -0,0 +1,1366 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast +import warnings + +from google.cloud.oslogin_v1 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, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + +from google.cloud.oslogin.common.types import common +from google.cloud.oslogin_v1.types import oslogin +from google.protobuf import field_mask_pb2 # type: ignore +from .transports.base import OsLoginServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import OsLoginServiceGrpcTransport +from .transports.grpc_asyncio import OsLoginServiceGrpcAsyncIOTransport +from .transports.rest import OsLoginServiceRestTransport + + +class OsLoginServiceClientMeta(type): + """Metaclass for the OsLoginService 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[OsLoginServiceTransport]] + _transport_registry["grpc"] = OsLoginServiceGrpcTransport + _transport_registry["grpc_asyncio"] = OsLoginServiceGrpcAsyncIOTransport + _transport_registry["rest"] = OsLoginServiceRestTransport + + def get_transport_class(cls, + label: Optional[str] = None, + ) -> Type[OsLoginServiceTransport]: + """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 OsLoginServiceClient(metaclass=OsLoginServiceClientMeta): + """Cloud OS Login API + + The Cloud OS Login API allows you to manage users and their + associated SSH public keys for logging into virtual machines on + Google Cloud Platform. + """ + + @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") + + # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. + DEFAULT_ENDPOINT = "oslogin.googleapis.com" + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + _DEFAULT_ENDPOINT_TEMPLATE = "oslogin.{UNIVERSE_DOMAIN}" + _DEFAULT_UNIVERSE = "googleapis.com" + + @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: + OsLoginServiceClient: 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: + OsLoginServiceClient: 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) -> OsLoginServiceTransport: + """Returns the transport used by the client instance. + + Returns: + OsLoginServiceTransport: The transport used by the client + instance. + """ + return self._transport + + @staticmethod + def posix_account_path(user: str,project: str,) -> str: + """Returns a fully-qualified posix_account string.""" + return "users/{user}/projects/{project}".format(user=user, project=project, ) + + @staticmethod + def parse_posix_account_path(path: str) -> Dict[str,str]: + """Parses a posix_account path into its component segments.""" + m = re.match(r"^users/(?P.+?)/projects/(?P.+?)$", path) + return m.groupdict() if m else {} + + @staticmethod + def ssh_public_key_path(user: str,fingerprint: str,) -> str: + """Returns a fully-qualified ssh_public_key string.""" + return "users/{user}/sshPublicKeys/{fingerprint}".format(user=user, fingerprint=fingerprint, ) + + @staticmethod + def parse_ssh_public_key_path(path: str) -> Dict[str,str]: + """Parses a ssh_public_key path into its component segments.""" + m = re.match(r"^users/(?P.+?)/sshPublicKeys/(?P.+?)$", path) + return m.groupdict() if m else {} + + @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): + """Deprecated. 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. + """ + + warnings.warn("get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", + DeprecationWarning) + 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 + + @staticmethod + def _read_environment_variables(): + """Returns the environment variables used by the client. + + Returns: + Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, + GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. + + Raises: + ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not + any of ["true", "false"]. + google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT + is not any of ["auto", "never", "always"]. + """ + use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false").lower() + use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() + universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") + 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`") + return use_client_cert == "true", use_mtls_endpoint, universe_domain_env + + @staticmethod + def _get_client_cert_source(provided_cert_source, use_cert_flag): + """Return the client cert source to be used by the client. + + Args: + provided_cert_source (bytes): The client certificate source provided. + use_cert_flag (bool): A flag indicating whether to use the client certificate. + + Returns: + bytes or None: The client cert source to be used by the client. + """ + client_cert_source = None + if use_cert_flag: + if provided_cert_source: + client_cert_source = provided_cert_source + elif mtls.has_default_client_cert_source(): + client_cert_source = mtls.default_client_cert_source() + return client_cert_source + + @staticmethod + def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint): + """Return the API endpoint used by the client. + + Args: + api_override (str): The API endpoint override. If specified, this is always + the return value of this function and the other arguments are not used. + client_cert_source (bytes): The client certificate source used by the client. + universe_domain (str): The universe domain used by the client. + use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. + Possible values are "always", "auto", or "never". + + Returns: + str: The API endpoint to be used by the client. + """ + if api_override is not None: + api_endpoint = api_override + elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): + _default_universe = OsLoginServiceClient._DEFAULT_UNIVERSE + if universe_domain != _default_universe: + raise MutualTLSChannelError(f"mTLS is not supported in any universe other than {_default_universe}.") + api_endpoint = OsLoginServiceClient.DEFAULT_MTLS_ENDPOINT + else: + api_endpoint = OsLoginServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=universe_domain) + return api_endpoint + + @staticmethod + def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_env: Optional[str]) -> str: + """Return the universe domain used by the client. + + Args: + client_universe_domain (Optional[str]): The universe domain configured via the client options. + universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. + + Returns: + str: The universe domain to be used by the client. + + Raises: + ValueError: If the universe domain is an empty string. + """ + universe_domain = OsLoginServiceClient._DEFAULT_UNIVERSE + if client_universe_domain is not None: + universe_domain = client_universe_domain + elif universe_domain_env is not None: + universe_domain = universe_domain_env + if len(universe_domain.strip()) == 0: + raise ValueError("Universe Domain cannot be an empty string.") + return universe_domain + + @staticmethod + def _compare_universes(client_universe: str, + credentials: ga_credentials.Credentials) -> bool: + """Returns True iff the universe domains used by the client and credentials match. + + Args: + client_universe (str): The universe domain configured via the client options. + credentials (ga_credentials.Credentials): The credentials being used in the client. + + Returns: + bool: True iff client_universe matches the universe in credentials. + + Raises: + ValueError: when client_universe does not match the universe in credentials. + """ + + default_universe = OsLoginServiceClient._DEFAULT_UNIVERSE + credentials_universe = getattr(credentials, "universe_domain", default_universe) + + if client_universe != credentials_universe: + raise ValueError("The configured universe domain " + f"({client_universe}) does not match the universe domain " + f"found in the credentials ({credentials_universe}). " + "If you haven't configured the universe domain explicitly, " + f"`{default_universe}` is the default.") + return True + + def _validate_universe_domain(self): + """Validates client's and credentials' universe domains are consistent. + + Returns: + bool: True iff the configured universe domain is valid. + + Raises: + ValueError: If the configured universe domain is not valid. + """ + self._is_universe_domain_valid = (self._is_universe_domain_valid or + OsLoginServiceClient._compare_universes(self.universe_domain, self.transport._credentials)) + return self._is_universe_domain_valid + + @property + def api_endpoint(self): + """Return the API endpoint used by the client instance. + + Returns: + str: The API endpoint used by the client instance. + """ + return self._api_endpoint + + @property + def universe_domain(self) -> str: + """Return the universe domain used by the client instance. + + Returns: + str: The universe domain used by the client instance. + """ + return self._universe_domain + + def __init__(self, *, + credentials: Optional[ga_credentials.Credentials] = None, + transport: Optional[Union[str, OsLoginServiceTransport, Callable[..., OsLoginServiceTransport]]] = None, + client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiates the os login service 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 (Optional[Union[str,OsLoginServiceTransport,Callable[..., OsLoginServiceTransport]]]): + The transport to use, or a Callable that constructs and returns a new transport. + If a Callable is given, it will be called with the same set of initialization + arguments as used in the OsLoginServiceTransport constructor. + 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. + + 1. The ``api_endpoint`` property can be used to override the + default endpoint provided by the client when ``transport`` is + not explicitly provided. Only if this property is not set and + ``transport`` was not explicitly provided, the endpoint is + determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment + variable, which have one of the following values: + "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). + + 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide a client certificate for mTLS 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. + + 3. The ``universe_domain`` property can be used to override the + default "googleapis.com" universe. Note that the ``api_endpoint`` + property still takes precedence; and ``universe_domain`` is + currently not supported for mTLS. + + 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. + """ + self._client_options = client_options + if isinstance(self._client_options, dict): + self._client_options = client_options_lib.from_dict(self._client_options) + if self._client_options is None: + self._client_options = client_options_lib.ClientOptions() + self._client_options = cast(client_options_lib.ClientOptions, self._client_options) + + universe_domain_opt = getattr(self._client_options, 'universe_domain', None) + + self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = OsLoginServiceClient._read_environment_variables() + self._client_cert_source = OsLoginServiceClient._get_client_cert_source(self._client_options.client_cert_source, self._use_client_cert) + self._universe_domain = OsLoginServiceClient._get_universe_domain(universe_domain_opt, self._universe_domain_env) + self._api_endpoint = None # updated below, depending on `transport` + + # Initialize the universe domain validation. + self._is_universe_domain_valid = False + + api_key_value = getattr(self._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. + transport_provided = isinstance(transport, OsLoginServiceTransport) + if transport_provided: + # transport is a OsLoginServiceTransport instance. + if credentials or self._client_options.credentials_file or api_key_value: + raise ValueError("When providing a transport instance, " + "provide its credentials directly.") + if self._client_options.scopes: + raise ValueError( + "When providing a transport instance, provide its scopes " + "directly." + ) + self._transport = cast(OsLoginServiceTransport, transport) + self._api_endpoint = self._transport.host + + self._api_endpoint = (self._api_endpoint or + OsLoginServiceClient._get_api_endpoint( + self._client_options.api_endpoint, + self._client_cert_source, + self._universe_domain, + self._use_mtls_endpoint)) + + if not transport_provided: + 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_init: Union[Type[OsLoginServiceTransport], Callable[..., OsLoginServiceTransport]] = ( + type(self).get_transport_class(transport) + if isinstance(transport, str) or transport is None + else cast(Callable[..., OsLoginServiceTransport], transport) + ) + # initialize with the provided callable or the passed in class + self._transport = transport_init( + credentials=credentials, + credentials_file=self._client_options.credentials_file, + host=self._api_endpoint, + scopes=self._client_options.scopes, + client_cert_source_for_mtls=self._client_cert_source, + quota_project_id=self._client_options.quota_project_id, + client_info=client_info, + always_use_jwt_access=True, + api_audience=self._client_options.api_audience, + ) + + def create_ssh_public_key(self, + request: Optional[Union[oslogin.CreateSshPublicKeyRequest, dict]] = None, + *, + parent: Optional[str] = None, + ssh_public_key: Optional[common.SshPublicKey] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> common.SshPublicKey: + r"""Create an SSH public key + + .. 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 oslogin_v1 + + def sample_create_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.CreateSshPublicKeyRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_ssh_public_key(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.oslogin_v1.types.CreateSshPublicKeyRequest, dict]): + The request object. A request message for creating an SSH + public key. + parent (str): + Required. The unique ID for the user in format + ``users/{user}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + ssh_public_key (google.cloud.oslogin.common.types.SshPublicKey): + Required. The SSH public key and + expiration time. + + This corresponds to the ``ssh_public_key`` 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.oslogin.common.types.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + # 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([parent, ssh_public_key]) + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.CreateSshPublicKeyRequest): + request = oslogin.CreateSshPublicKeyRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if ssh_public_key is not None: + request.ssh_public_key = ssh_public_key + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.create_ssh_public_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def delete_posix_account(self, + request: Optional[Union[oslogin.DeletePosixAccountRequest, dict]] = None, + *, + name: 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 a POSIX account. + + .. 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 oslogin_v1 + + def sample_delete_posix_account(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.DeletePosixAccountRequest( + name="name_value", + ) + + # Make the request + client.delete_posix_account(request=request) + + Args: + request (Union[google.cloud.oslogin_v1.types.DeletePosixAccountRequest, dict]): + The request object. A request message for deleting a + POSIX account entry. + name (str): + Required. A reference to the POSIX account to update. + POSIX accounts are identified by the project ID they are + associated with. A reference to the POSIX account is in + format ``users/{user}/projects/{project}``. + + This corresponds to the ``name`` 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([name]) + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.DeletePosixAccountRequest): + request = oslogin.DeletePosixAccountRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_posix_account] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def delete_ssh_public_key(self, + request: Optional[Union[oslogin.DeleteSshPublicKeyRequest, dict]] = None, + *, + name: 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 an SSH public key. + + .. 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 oslogin_v1 + + def sample_delete_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.DeleteSshPublicKeyRequest( + name="name_value", + ) + + # Make the request + client.delete_ssh_public_key(request=request) + + Args: + request (Union[google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest, dict]): + The request object. A request message for deleting an SSH + public key. + name (str): + Required. The fingerprint of the public key to update. + Public keys are identified by their SHA-256 fingerprint. + The fingerprint of the public key is in format + ``users/{user}/sshPublicKeys/{fingerprint}``. + + This corresponds to the ``name`` 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([name]) + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.DeleteSshPublicKeyRequest): + request = oslogin.DeleteSshPublicKeyRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.delete_ssh_public_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def get_login_profile(self, + request: Optional[Union[oslogin.GetLoginProfileRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> oslogin.LoginProfile: + r"""Retrieves the profile information used for logging in + to a virtual machine on Google Compute Engine. + + .. 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 oslogin_v1 + + def sample_get_login_profile(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.GetLoginProfileRequest( + name="name_value", + ) + + # Make the request + response = client.get_login_profile(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.oslogin_v1.types.GetLoginProfileRequest, dict]): + The request object. A request message for retrieving the + login profile information for a user. + name (str): + Required. The unique ID for the user in format + ``users/{user}``. + + This corresponds to the ``name`` 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.oslogin_v1.types.LoginProfile: + The user profile information used for + logging in to a virtual machine on + Google Compute Engine. + + """ + # 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([name]) + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.GetLoginProfileRequest): + request = oslogin.GetLoginProfileRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_login_profile] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def get_ssh_public_key(self, + request: Optional[Union[oslogin.GetSshPublicKeyRequest, dict]] = None, + *, + name: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> common.SshPublicKey: + r"""Retrieves an SSH public key. + + .. 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 oslogin_v1 + + def sample_get_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.GetSshPublicKeyRequest( + name="name_value", + ) + + # Make the request + response = client.get_ssh_public_key(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.oslogin_v1.types.GetSshPublicKeyRequest, dict]): + The request object. A request message for retrieving an + SSH public key. + name (str): + Required. The fingerprint of the public key to retrieve. + Public keys are identified by their SHA-256 fingerprint. + The fingerprint of the public key is in format + ``users/{user}/sshPublicKeys/{fingerprint}``. + + This corresponds to the ``name`` 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.oslogin.common.types.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + # 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([name]) + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.GetSshPublicKeyRequest): + request = oslogin.GetSshPublicKeyRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.get_ssh_public_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def import_ssh_public_key(self, + request: Optional[Union[oslogin.ImportSshPublicKeyRequest, dict]] = None, + *, + parent: Optional[str] = None, + ssh_public_key: Optional[common.SshPublicKey] = None, + project_id: Optional[str] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> oslogin.ImportSshPublicKeyResponse: + r"""Adds an SSH public key and returns the profile + information. Default POSIX account information is set + when no username and UID exist as part of the login + profile. + + .. 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 oslogin_v1 + + def sample_import_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.ImportSshPublicKeyRequest( + parent="parent_value", + ) + + # Make the request + response = client.import_ssh_public_key(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest, dict]): + The request object. A request message for importing an + SSH public key. + parent (str): + Required. The unique ID for the user in format + ``users/{user}``. + + This corresponds to the ``parent`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + ssh_public_key (google.cloud.oslogin.common.types.SshPublicKey): + Optional. The SSH public key and + expiration time. + + This corresponds to the ``ssh_public_key`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + project_id (str): + The project ID of the Google Cloud + Platform project. + + This corresponds to the ``project_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.oslogin_v1.types.ImportSshPublicKeyResponse: + A response message for importing an + SSH public key. + + """ + # 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([parent, ssh_public_key, project_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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.ImportSshPublicKeyRequest): + request = oslogin.ImportSshPublicKeyRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if parent is not None: + request.parent = parent + if ssh_public_key is not None: + request.ssh_public_key = ssh_public_key + if project_id is not None: + request.project_id = project_id + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.import_ssh_public_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("parent", request.parent), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def update_ssh_public_key(self, + request: Optional[Union[oslogin.UpdateSshPublicKeyRequest, dict]] = None, + *, + name: Optional[str] = None, + ssh_public_key: Optional[common.SshPublicKey] = None, + update_mask: Optional[field_mask_pb2.FieldMask] = None, + retry: OptionalRetry = gapic_v1.method.DEFAULT, + timeout: Union[float, object] = gapic_v1.method.DEFAULT, + metadata: Sequence[Tuple[str, str]] = (), + ) -> common.SshPublicKey: + r"""Updates an SSH public key and returns the profile + information. This method supports patch semantics. + + .. 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 oslogin_v1 + + def sample_update_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.UpdateSshPublicKeyRequest( + name="name_value", + ) + + # Make the request + response = client.update_ssh_public_key(request=request) + + # Handle the response + print(response) + + Args: + request (Union[google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest, dict]): + The request object. A request message for updating an SSH + public key. + name (str): + Required. The fingerprint of the public key to update. + Public keys are identified by their SHA-256 fingerprint. + The fingerprint of the public key is in format + ``users/{user}/sshPublicKeys/{fingerprint}``. + + This corresponds to the ``name`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + ssh_public_key (google.cloud.oslogin.common.types.SshPublicKey): + Required. The SSH public key and + expiration time. + + This corresponds to the ``ssh_public_key`` field + on the ``request`` instance; if ``request`` is provided, this + should not be set. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Mask to control which fields get + updated. Updates all if not present. + + This corresponds to the ``update_mask`` 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.oslogin.common.types.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + # 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([name, ssh_public_key, update_mask]) + 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.') + + # - Use the request object if provided (there's no risk of modifying the input as + # there are no flattened fields), or create one. + if not isinstance(request, oslogin.UpdateSshPublicKeyRequest): + request = oslogin.UpdateSshPublicKeyRequest(request) + # If we have keyword arguments corresponding to fields on the + # request, apply these. + if name is not None: + request.name = name + if ssh_public_key is not None: + request.ssh_public_key = ssh_public_key + if update_mask is not None: + request.update_mask = update_mask + + # Wrap the RPC method; this adds retry and timeout information, + # and friendly error handling. + rpc = self._transport._wrapped_methods[self._transport.update_ssh_public_key] + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ("name", request.name), + )), + ) + + # Validate the universe domain. + self._validate_universe_domain() + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + def __enter__(self) -> "OsLoginServiceClient": + 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__ = ( + "OsLoginServiceClient", +) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py new file mode 100644 index 000000000000..6d093d3585c4 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 OsLoginServiceTransport +from .grpc import OsLoginServiceGrpcTransport +from .grpc_asyncio import OsLoginServiceGrpcAsyncIOTransport +from .rest import OsLoginServiceRestTransport +from .rest import OsLoginServiceRestInterceptor + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[OsLoginServiceTransport]] +_transport_registry['grpc'] = OsLoginServiceGrpcTransport +_transport_registry['grpc_asyncio'] = OsLoginServiceGrpcAsyncIOTransport +_transport_registry['rest'] = OsLoginServiceRestTransport + +__all__ = ( + 'OsLoginServiceTransport', + 'OsLoginServiceGrpcTransport', + 'OsLoginServiceGrpcAsyncIOTransport', + 'OsLoginServiceRestTransport', + 'OsLoginServiceRestInterceptor', +) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py new file mode 100644 index 000000000000..0e01aac8f2b8 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py @@ -0,0 +1,301 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.oslogin_v1 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.oslogin.common.types import common +from google.cloud.oslogin_v1.types import oslogin +from google.protobuf import empty_pb2 # type: ignore + +DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) + + +class OsLoginServiceTransport(abc.ABC): + """Abstract transport class for OsLoginService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/cloud-platform.read-only', + 'https://www.googleapis.com/auth/compute', + 'https://www.googleapis.com/auth/compute.readonly', + ) + + DEFAULT_HOST: str = 'oslogin.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 (default: 'oslogin.googleapis.com'). + 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 + + @property + def host(self): + return self._host + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + self.create_ssh_public_key: gapic_v1.method.wrap_method( + self.create_ssh_public_key, + default_timeout=None, + client_info=client_info, + ), + self.delete_posix_account: gapic_v1.method.wrap_method( + self.delete_posix_account, + 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=10.0, + ), + default_timeout=10.0, + client_info=client_info, + ), + self.delete_ssh_public_key: gapic_v1.method.wrap_method( + self.delete_ssh_public_key, + 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=10.0, + ), + default_timeout=10.0, + client_info=client_info, + ), + self.get_login_profile: gapic_v1.method.wrap_method( + self.get_login_profile, + 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=10.0, + ), + default_timeout=10.0, + client_info=client_info, + ), + self.get_ssh_public_key: gapic_v1.method.wrap_method( + self.get_ssh_public_key, + 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=10.0, + ), + default_timeout=10.0, + client_info=client_info, + ), + self.import_ssh_public_key: gapic_v1.method.wrap_method( + self.import_ssh_public_key, + 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=10.0, + ), + default_timeout=10.0, + client_info=client_info, + ), + self.update_ssh_public_key: gapic_v1.method.wrap_method( + self.update_ssh_public_key, + 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=10.0, + ), + default_timeout=10.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 create_ssh_public_key(self) -> Callable[ + [oslogin.CreateSshPublicKeyRequest], + Union[ + common.SshPublicKey, + Awaitable[common.SshPublicKey] + ]]: + raise NotImplementedError() + + @property + def delete_posix_account(self) -> Callable[ + [oslogin.DeletePosixAccountRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def delete_ssh_public_key(self) -> Callable[ + [oslogin.DeleteSshPublicKeyRequest], + Union[ + empty_pb2.Empty, + Awaitable[empty_pb2.Empty] + ]]: + raise NotImplementedError() + + @property + def get_login_profile(self) -> Callable[ + [oslogin.GetLoginProfileRequest], + Union[ + oslogin.LoginProfile, + Awaitable[oslogin.LoginProfile] + ]]: + raise NotImplementedError() + + @property + def get_ssh_public_key(self) -> Callable[ + [oslogin.GetSshPublicKeyRequest], + Union[ + common.SshPublicKey, + Awaitable[common.SshPublicKey] + ]]: + raise NotImplementedError() + + @property + def import_ssh_public_key(self) -> Callable[ + [oslogin.ImportSshPublicKeyRequest], + Union[ + oslogin.ImportSshPublicKeyResponse, + Awaitable[oslogin.ImportSshPublicKeyResponse] + ]]: + raise NotImplementedError() + + @property + def update_ssh_public_key(self) -> Callable[ + [oslogin.UpdateSshPublicKeyRequest], + Union[ + common.SshPublicKey, + Awaitable[common.SshPublicKey] + ]]: + raise NotImplementedError() + + @property + def kind(self) -> str: + raise NotImplementedError() + + +__all__ = ( + 'OsLoginServiceTransport', +) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py new file mode 100644 index 000000000000..c819bd20a0a0 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py @@ -0,0 +1,436 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.oslogin.common.types import common +from google.cloud.oslogin_v1.types import oslogin +from google.protobuf import empty_pb2 # type: ignore +from .base import OsLoginServiceTransport, DEFAULT_CLIENT_INFO + + +class OsLoginServiceGrpcTransport(OsLoginServiceTransport): + """gRPC backend transport for OsLoginService. + + Cloud OS Login API + + The Cloud OS Login API allows you to manage users and their + associated SSH public keys for logging into virtual machines on + Google Cloud Platform. + + 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 = 'oslogin.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[grpc.Channel, Callable[..., 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 (default: 'oslogin.googleapis.com'). + 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 a ``channel`` instance 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 a ``channel`` instance is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if a ``channel`` instance is provided. + channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + 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 a ``channel`` instance 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 a ``channel`` instance 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 isinstance(channel, grpc.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: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + 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 = 'oslogin.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 create_ssh_public_key(self) -> Callable[ + [oslogin.CreateSshPublicKeyRequest], + common.SshPublicKey]: + r"""Return a callable for the create ssh public key method over gRPC. + + Create an SSH public key + + Returns: + Callable[[~.CreateSshPublicKeyRequest], + ~.SshPublicKey]: + 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 'create_ssh_public_key' not in self._stubs: + self._stubs['create_ssh_public_key'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/CreateSshPublicKey', + request_serializer=oslogin.CreateSshPublicKeyRequest.serialize, + response_deserializer=common.SshPublicKey.deserialize, + ) + return self._stubs['create_ssh_public_key'] + + @property + def delete_posix_account(self) -> Callable[ + [oslogin.DeletePosixAccountRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete posix account method over gRPC. + + Deletes a POSIX account. + + Returns: + Callable[[~.DeletePosixAccountRequest], + ~.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_posix_account' not in self._stubs: + self._stubs['delete_posix_account'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/DeletePosixAccount', + request_serializer=oslogin.DeletePosixAccountRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_posix_account'] + + @property + def delete_ssh_public_key(self) -> Callable[ + [oslogin.DeleteSshPublicKeyRequest], + empty_pb2.Empty]: + r"""Return a callable for the delete ssh public key method over gRPC. + + Deletes an SSH public key. + + Returns: + Callable[[~.DeleteSshPublicKeyRequest], + ~.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_ssh_public_key' not in self._stubs: + self._stubs['delete_ssh_public_key'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/DeleteSshPublicKey', + request_serializer=oslogin.DeleteSshPublicKeyRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_ssh_public_key'] + + @property + def get_login_profile(self) -> Callable[ + [oslogin.GetLoginProfileRequest], + oslogin.LoginProfile]: + r"""Return a callable for the get login profile method over gRPC. + + Retrieves the profile information used for logging in + to a virtual machine on Google Compute Engine. + + Returns: + Callable[[~.GetLoginProfileRequest], + ~.LoginProfile]: + 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_login_profile' not in self._stubs: + self._stubs['get_login_profile'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/GetLoginProfile', + request_serializer=oslogin.GetLoginProfileRequest.serialize, + response_deserializer=oslogin.LoginProfile.deserialize, + ) + return self._stubs['get_login_profile'] + + @property + def get_ssh_public_key(self) -> Callable[ + [oslogin.GetSshPublicKeyRequest], + common.SshPublicKey]: + r"""Return a callable for the get ssh public key method over gRPC. + + Retrieves an SSH public key. + + Returns: + Callable[[~.GetSshPublicKeyRequest], + ~.SshPublicKey]: + 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_ssh_public_key' not in self._stubs: + self._stubs['get_ssh_public_key'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/GetSshPublicKey', + request_serializer=oslogin.GetSshPublicKeyRequest.serialize, + response_deserializer=common.SshPublicKey.deserialize, + ) + return self._stubs['get_ssh_public_key'] + + @property + def import_ssh_public_key(self) -> Callable[ + [oslogin.ImportSshPublicKeyRequest], + oslogin.ImportSshPublicKeyResponse]: + r"""Return a callable for the import ssh public key method over gRPC. + + Adds an SSH public key and returns the profile + information. Default POSIX account information is set + when no username and UID exist as part of the login + profile. + + Returns: + Callable[[~.ImportSshPublicKeyRequest], + ~.ImportSshPublicKeyResponse]: + 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 'import_ssh_public_key' not in self._stubs: + self._stubs['import_ssh_public_key'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/ImportSshPublicKey', + request_serializer=oslogin.ImportSshPublicKeyRequest.serialize, + response_deserializer=oslogin.ImportSshPublicKeyResponse.deserialize, + ) + return self._stubs['import_ssh_public_key'] + + @property + def update_ssh_public_key(self) -> Callable[ + [oslogin.UpdateSshPublicKeyRequest], + common.SshPublicKey]: + r"""Return a callable for the update ssh public key method over gRPC. + + Updates an SSH public key and returns the profile + information. This method supports patch semantics. + + Returns: + Callable[[~.UpdateSshPublicKeyRequest], + ~.SshPublicKey]: + 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_ssh_public_key' not in self._stubs: + self._stubs['update_ssh_public_key'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/UpdateSshPublicKey', + request_serializer=oslogin.UpdateSshPublicKeyRequest.serialize, + response_deserializer=common.SshPublicKey.deserialize, + ) + return self._stubs['update_ssh_public_key'] + + def close(self): + self.grpc_channel.close() + + @property + def kind(self) -> str: + return "grpc" + + +__all__ = ( + 'OsLoginServiceGrpcTransport', +) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py new file mode 100644 index 000000000000..28c403c1b21e --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py @@ -0,0 +1,536 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.api_core import exceptions as core_exceptions +from google.api_core import retry_async as retries +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.oslogin.common.types import common +from google.cloud.oslogin_v1.types import oslogin +from google.protobuf import empty_pb2 # type: ignore +from .base import OsLoginServiceTransport, DEFAULT_CLIENT_INFO +from .grpc import OsLoginServiceGrpcTransport + + +class OsLoginServiceGrpcAsyncIOTransport(OsLoginServiceTransport): + """gRPC AsyncIO backend transport for OsLoginService. + + Cloud OS Login API + + The Cloud OS Login API allows you to manage users and their + associated SSH public keys for logging into virtual machines on + Google Cloud Platform. + + 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 = 'oslogin.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`. + 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 = 'oslogin.googleapis.com', + credentials: Optional[ga_credentials.Credentials] = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: Optional[Union[aio.Channel, Callable[..., 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 (default: 'oslogin.googleapis.com'). + 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 a ``channel`` instance 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 a ``channel`` instance 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[Union[aio.Channel, Callable[..., aio.Channel]]]): + A ``Channel`` instance through which to make calls, or a Callable + that constructs and returns one. If set to None, ``self.create_channel`` + is used to create the channel. If a Callable is given, it will be called + with the same arguments as used in ``self.create_channel``. + 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 a ``channel`` instance 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 a ``channel`` instance 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 isinstance(channel, aio.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: + # initialize with the provided callable or the default channel + channel_init = channel or type(self).create_channel + self._grpc_channel = channel_init( + 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 create_ssh_public_key(self) -> Callable[ + [oslogin.CreateSshPublicKeyRequest], + Awaitable[common.SshPublicKey]]: + r"""Return a callable for the create ssh public key method over gRPC. + + Create an SSH public key + + Returns: + Callable[[~.CreateSshPublicKeyRequest], + Awaitable[~.SshPublicKey]]: + 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 'create_ssh_public_key' not in self._stubs: + self._stubs['create_ssh_public_key'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/CreateSshPublicKey', + request_serializer=oslogin.CreateSshPublicKeyRequest.serialize, + response_deserializer=common.SshPublicKey.deserialize, + ) + return self._stubs['create_ssh_public_key'] + + @property + def delete_posix_account(self) -> Callable[ + [oslogin.DeletePosixAccountRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete posix account method over gRPC. + + Deletes a POSIX account. + + Returns: + Callable[[~.DeletePosixAccountRequest], + 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_posix_account' not in self._stubs: + self._stubs['delete_posix_account'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/DeletePosixAccount', + request_serializer=oslogin.DeletePosixAccountRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_posix_account'] + + @property + def delete_ssh_public_key(self) -> Callable[ + [oslogin.DeleteSshPublicKeyRequest], + Awaitable[empty_pb2.Empty]]: + r"""Return a callable for the delete ssh public key method over gRPC. + + Deletes an SSH public key. + + Returns: + Callable[[~.DeleteSshPublicKeyRequest], + 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_ssh_public_key' not in self._stubs: + self._stubs['delete_ssh_public_key'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/DeleteSshPublicKey', + request_serializer=oslogin.DeleteSshPublicKeyRequest.serialize, + response_deserializer=empty_pb2.Empty.FromString, + ) + return self._stubs['delete_ssh_public_key'] + + @property + def get_login_profile(self) -> Callable[ + [oslogin.GetLoginProfileRequest], + Awaitable[oslogin.LoginProfile]]: + r"""Return a callable for the get login profile method over gRPC. + + Retrieves the profile information used for logging in + to a virtual machine on Google Compute Engine. + + Returns: + Callable[[~.GetLoginProfileRequest], + Awaitable[~.LoginProfile]]: + 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_login_profile' not in self._stubs: + self._stubs['get_login_profile'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/GetLoginProfile', + request_serializer=oslogin.GetLoginProfileRequest.serialize, + response_deserializer=oslogin.LoginProfile.deserialize, + ) + return self._stubs['get_login_profile'] + + @property + def get_ssh_public_key(self) -> Callable[ + [oslogin.GetSshPublicKeyRequest], + Awaitable[common.SshPublicKey]]: + r"""Return a callable for the get ssh public key method over gRPC. + + Retrieves an SSH public key. + + Returns: + Callable[[~.GetSshPublicKeyRequest], + Awaitable[~.SshPublicKey]]: + 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_ssh_public_key' not in self._stubs: + self._stubs['get_ssh_public_key'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/GetSshPublicKey', + request_serializer=oslogin.GetSshPublicKeyRequest.serialize, + response_deserializer=common.SshPublicKey.deserialize, + ) + return self._stubs['get_ssh_public_key'] + + @property + def import_ssh_public_key(self) -> Callable[ + [oslogin.ImportSshPublicKeyRequest], + Awaitable[oslogin.ImportSshPublicKeyResponse]]: + r"""Return a callable for the import ssh public key method over gRPC. + + Adds an SSH public key and returns the profile + information. Default POSIX account information is set + when no username and UID exist as part of the login + profile. + + Returns: + Callable[[~.ImportSshPublicKeyRequest], + Awaitable[~.ImportSshPublicKeyResponse]]: + 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 'import_ssh_public_key' not in self._stubs: + self._stubs['import_ssh_public_key'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/ImportSshPublicKey', + request_serializer=oslogin.ImportSshPublicKeyRequest.serialize, + response_deserializer=oslogin.ImportSshPublicKeyResponse.deserialize, + ) + return self._stubs['import_ssh_public_key'] + + @property + def update_ssh_public_key(self) -> Callable[ + [oslogin.UpdateSshPublicKeyRequest], + Awaitable[common.SshPublicKey]]: + r"""Return a callable for the update ssh public key method over gRPC. + + Updates an SSH public key and returns the profile + information. This method supports patch semantics. + + Returns: + Callable[[~.UpdateSshPublicKeyRequest], + Awaitable[~.SshPublicKey]]: + 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_ssh_public_key' not in self._stubs: + self._stubs['update_ssh_public_key'] = self.grpc_channel.unary_unary( + '/google.cloud.oslogin.v1.OsLoginService/UpdateSshPublicKey', + request_serializer=oslogin.UpdateSshPublicKeyRequest.serialize, + response_deserializer=common.SshPublicKey.deserialize, + ) + return self._stubs['update_ssh_public_key'] + + def _prep_wrapped_messages(self, client_info): + """ Precompute the wrapped methods, overriding the base class method to use async wrappers.""" + self._wrapped_methods = { + self.create_ssh_public_key: gapic_v1.method_async.wrap_method( + self.create_ssh_public_key, + default_timeout=None, + client_info=client_info, + ), + self.delete_posix_account: gapic_v1.method_async.wrap_method( + self.delete_posix_account, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=client_info, + ), + self.delete_ssh_public_key: gapic_v1.method_async.wrap_method( + self.delete_ssh_public_key, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=client_info, + ), + self.get_login_profile: gapic_v1.method_async.wrap_method( + self.get_login_profile, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=client_info, + ), + self.get_ssh_public_key: gapic_v1.method_async.wrap_method( + self.get_ssh_public_key, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=client_info, + ), + self.import_ssh_public_key: gapic_v1.method_async.wrap_method( + self.import_ssh_public_key, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=client_info, + ), + self.update_ssh_public_key: gapic_v1.method_async.wrap_method( + self.update_ssh_public_key, + default_retry=retries.AsyncRetry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + core_exceptions.DeadlineExceeded, + core_exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=client_info, + ), + } + + def close(self): + return self.grpc_channel.close() + + +__all__ = ( + 'OsLoginServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/rest.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/rest.py new file mode 100644 index 000000000000..e2db6459b73c --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/rest.py @@ -0,0 +1,941 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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, None] +except AttributeError: # pragma: NO COVER + OptionalRetry = Union[retries.Retry, object, None] # type: ignore + + +from google.cloud.oslogin.common.types import common +from google.cloud.oslogin_v1.types import oslogin +from google.protobuf import empty_pb2 # type: ignore + +from .base import OsLoginServiceTransport, 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 OsLoginServiceRestInterceptor: + """Interceptor for OsLoginService. + + 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 OsLoginServiceRestTransport. + + .. code-block:: python + class MyCustomOsLoginServiceInterceptor(OsLoginServiceRestInterceptor): + def pre_create_ssh_public_key(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_create_ssh_public_key(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_delete_posix_account(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_delete_ssh_public_key(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def pre_get_login_profile(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_login_profile(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_get_ssh_public_key(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_get_ssh_public_key(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_import_ssh_public_key(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_import_ssh_public_key(self, response): + logging.log(f"Received response: {response}") + return response + + def pre_update_ssh_public_key(self, request, metadata): + logging.log(f"Received request: {request}") + return request, metadata + + def post_update_ssh_public_key(self, response): + logging.log(f"Received response: {response}") + return response + + transport = OsLoginServiceRestTransport(interceptor=MyCustomOsLoginServiceInterceptor()) + client = OsLoginServiceClient(transport=transport) + + + """ + def pre_create_ssh_public_key(self, request: oslogin.CreateSshPublicKeyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.CreateSshPublicKeyRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for create_ssh_public_key + + Override in a subclass to manipulate the request or metadata + before they are sent to the OsLoginService server. + """ + return request, metadata + + def post_create_ssh_public_key(self, response: common.SshPublicKey) -> common.SshPublicKey: + """Post-rpc interceptor for create_ssh_public_key + + Override in a subclass to manipulate the response + after it is returned by the OsLoginService server but before + it is returned to user code. + """ + return response + def pre_delete_posix_account(self, request: oslogin.DeletePosixAccountRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.DeletePosixAccountRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_posix_account + + Override in a subclass to manipulate the request or metadata + before they are sent to the OsLoginService server. + """ + return request, metadata + + def pre_delete_ssh_public_key(self, request: oslogin.DeleteSshPublicKeyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.DeleteSshPublicKeyRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for delete_ssh_public_key + + Override in a subclass to manipulate the request or metadata + before they are sent to the OsLoginService server. + """ + return request, metadata + + def pre_get_login_profile(self, request: oslogin.GetLoginProfileRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.GetLoginProfileRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_login_profile + + Override in a subclass to manipulate the request or metadata + before they are sent to the OsLoginService server. + """ + return request, metadata + + def post_get_login_profile(self, response: oslogin.LoginProfile) -> oslogin.LoginProfile: + """Post-rpc interceptor for get_login_profile + + Override in a subclass to manipulate the response + after it is returned by the OsLoginService server but before + it is returned to user code. + """ + return response + def pre_get_ssh_public_key(self, request: oslogin.GetSshPublicKeyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.GetSshPublicKeyRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for get_ssh_public_key + + Override in a subclass to manipulate the request or metadata + before they are sent to the OsLoginService server. + """ + return request, metadata + + def post_get_ssh_public_key(self, response: common.SshPublicKey) -> common.SshPublicKey: + """Post-rpc interceptor for get_ssh_public_key + + Override in a subclass to manipulate the response + after it is returned by the OsLoginService server but before + it is returned to user code. + """ + return response + def pre_import_ssh_public_key(self, request: oslogin.ImportSshPublicKeyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.ImportSshPublicKeyRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for import_ssh_public_key + + Override in a subclass to manipulate the request or metadata + before they are sent to the OsLoginService server. + """ + return request, metadata + + def post_import_ssh_public_key(self, response: oslogin.ImportSshPublicKeyResponse) -> oslogin.ImportSshPublicKeyResponse: + """Post-rpc interceptor for import_ssh_public_key + + Override in a subclass to manipulate the response + after it is returned by the OsLoginService server but before + it is returned to user code. + """ + return response + def pre_update_ssh_public_key(self, request: oslogin.UpdateSshPublicKeyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.UpdateSshPublicKeyRequest, Sequence[Tuple[str, str]]]: + """Pre-rpc interceptor for update_ssh_public_key + + Override in a subclass to manipulate the request or metadata + before they are sent to the OsLoginService server. + """ + return request, metadata + + def post_update_ssh_public_key(self, response: common.SshPublicKey) -> common.SshPublicKey: + """Post-rpc interceptor for update_ssh_public_key + + Override in a subclass to manipulate the response + after it is returned by the OsLoginService server but before + it is returned to user code. + """ + return response + + +@dataclasses.dataclass +class OsLoginServiceRestStub: + _session: AuthorizedSession + _host: str + _interceptor: OsLoginServiceRestInterceptor + + +class OsLoginServiceRestTransport(OsLoginServiceTransport): + """REST backend transport for OsLoginService. + + Cloud OS Login API + + The Cloud OS Login API allows you to manage users and their + associated SSH public keys for logging into virtual machines on + Google Cloud Platform. + + 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 = 'oslogin.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[OsLoginServiceRestInterceptor] = None, + api_audience: Optional[str] = None, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): + The hostname to connect to (default: 'oslogin.googleapis.com'). + 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 OsLoginServiceRestInterceptor() + self._prep_wrapped_messages(client_info) + + class _CreateSshPublicKey(OsLoginServiceRestStub): + def __hash__(self): + return hash("CreateSshPublicKey") + + __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: oslogin.CreateSshPublicKeyRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> common.SshPublicKey: + r"""Call the create ssh public key method over HTTP. + + Args: + request (~.oslogin.CreateSshPublicKeyRequest): + The request object. A request message for creating an SSH + public key. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be 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: + ~.common.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{parent=users/*}/sshPublicKeys', + 'body': 'ssh_public_key', + }, + ] + request, metadata = self._interceptor.pre_create_ssh_public_key(request, metadata) + pb_request = oslogin.CreateSshPublicKeyRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + 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'], + 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 = common.SshPublicKey() + pb_resp = common.SshPublicKey.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_create_ssh_public_key(resp) + return resp + + class _DeletePosixAccount(OsLoginServiceRestStub): + def __hash__(self): + return hash("DeletePosixAccount") + + __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: oslogin.DeletePosixAccountRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the delete posix account method over HTTP. + + Args: + request (~.oslogin.DeletePosixAccountRequest): + The request object. A request message for deleting a + POSIX account entry. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be 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': '/v1/{name=users/*/projects/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_posix_account(request, metadata) + pb_request = oslogin.DeletePosixAccountRequest.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'], + 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 _DeleteSshPublicKey(OsLoginServiceRestStub): + def __hash__(self): + return hash("DeleteSshPublicKey") + + __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: oslogin.DeleteSshPublicKeyRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ): + r"""Call the delete ssh public key method over HTTP. + + Args: + request (~.oslogin.DeleteSshPublicKeyRequest): + The request object. A request message for deleting an SSH + public key. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be 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': '/v1/{name=users/*/sshPublicKeys/*}', + }, + ] + request, metadata = self._interceptor.pre_delete_ssh_public_key(request, metadata) + pb_request = oslogin.DeleteSshPublicKeyRequest.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'], + 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 _GetLoginProfile(OsLoginServiceRestStub): + def __hash__(self): + return hash("GetLoginProfile") + + __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: oslogin.GetLoginProfileRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> oslogin.LoginProfile: + r"""Call the get login profile method over HTTP. + + Args: + request (~.oslogin.GetLoginProfileRequest): + The request object. A request message for retrieving the + login profile information for a user. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be 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: + ~.oslogin.LoginProfile: + The user profile information used for + logging in to a virtual machine on + Google Compute Engine. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=users/*}/loginProfile', + }, + ] + request, metadata = self._interceptor.pre_get_login_profile(request, metadata) + pb_request = oslogin.GetLoginProfileRequest.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'], + 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 = oslogin.LoginProfile() + pb_resp = oslogin.LoginProfile.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_login_profile(resp) + return resp + + class _GetSshPublicKey(OsLoginServiceRestStub): + def __hash__(self): + return hash("GetSshPublicKey") + + __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: oslogin.GetSshPublicKeyRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> common.SshPublicKey: + r"""Call the get ssh public key method over HTTP. + + Args: + request (~.oslogin.GetSshPublicKeyRequest): + The request object. A request message for retrieving an + SSH public key. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be 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: + ~.common.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'get', + 'uri': '/v1/{name=users/*/sshPublicKeys/*}', + }, + ] + request, metadata = self._interceptor.pre_get_ssh_public_key(request, metadata) + pb_request = oslogin.GetSshPublicKeyRequest.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'], + 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 = common.SshPublicKey() + pb_resp = common.SshPublicKey.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_get_ssh_public_key(resp) + return resp + + class _ImportSshPublicKey(OsLoginServiceRestStub): + def __hash__(self): + return hash("ImportSshPublicKey") + + __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: oslogin.ImportSshPublicKeyRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> oslogin.ImportSshPublicKeyResponse: + r"""Call the import ssh public key method over HTTP. + + Args: + request (~.oslogin.ImportSshPublicKeyRequest): + The request object. A request message for importing an + SSH public key. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be 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: + ~.oslogin.ImportSshPublicKeyResponse: + A response message for importing an + SSH public key. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'post', + 'uri': '/v1/{parent=users/*}:importSshPublicKey', + 'body': 'ssh_public_key', + }, + ] + request, metadata = self._interceptor.pre_import_ssh_public_key(request, metadata) + pb_request = oslogin.ImportSshPublicKeyRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + 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'], + 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 = oslogin.ImportSshPublicKeyResponse() + pb_resp = oslogin.ImportSshPublicKeyResponse.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_import_ssh_public_key(resp) + return resp + + class _UpdateSshPublicKey(OsLoginServiceRestStub): + def __hash__(self): + return hash("UpdateSshPublicKey") + + __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: oslogin.UpdateSshPublicKeyRequest, *, + retry: OptionalRetry=gapic_v1.method.DEFAULT, + timeout: Optional[float]=None, + metadata: Sequence[Tuple[str, str]]=(), + ) -> common.SshPublicKey: + r"""Call the update ssh public key method over HTTP. + + Args: + request (~.oslogin.UpdateSshPublicKeyRequest): + The request object. A request message for updating an SSH + public key. + retry (google.api_core.retry.Retry): Designation of what errors, if any, + should be 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: + ~.common.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + + http_options: List[Dict[str, str]] = [{ + 'method': 'patch', + 'uri': '/v1/{name=users/*/sshPublicKeys/*}', + 'body': 'ssh_public_key', + }, + ] + request, metadata = self._interceptor.pre_update_ssh_public_key(request, metadata) + pb_request = oslogin.UpdateSshPublicKeyRequest.pb(request) + transcoded_request = path_template.transcode(http_options, pb_request) + + # Jsonify the request body + + body = json_format.MessageToJson( + transcoded_request['body'], + 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'], + 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 = common.SshPublicKey() + pb_resp = common.SshPublicKey.pb(resp) + + json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) + resp = self._interceptor.post_update_ssh_public_key(resp) + return resp + + @property + def create_ssh_public_key(self) -> Callable[ + [oslogin.CreateSshPublicKeyRequest], + common.SshPublicKey]: + # 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._CreateSshPublicKey(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_posix_account(self) -> Callable[ + [oslogin.DeletePosixAccountRequest], + 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._DeletePosixAccount(self._session, self._host, self._interceptor) # type: ignore + + @property + def delete_ssh_public_key(self) -> Callable[ + [oslogin.DeleteSshPublicKeyRequest], + 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._DeleteSshPublicKey(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_login_profile(self) -> Callable[ + [oslogin.GetLoginProfileRequest], + oslogin.LoginProfile]: + # 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._GetLoginProfile(self._session, self._host, self._interceptor) # type: ignore + + @property + def get_ssh_public_key(self) -> Callable[ + [oslogin.GetSshPublicKeyRequest], + common.SshPublicKey]: + # 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._GetSshPublicKey(self._session, self._host, self._interceptor) # type: ignore + + @property + def import_ssh_public_key(self) -> Callable[ + [oslogin.ImportSshPublicKeyRequest], + oslogin.ImportSshPublicKeyResponse]: + # 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._ImportSshPublicKey(self._session, self._host, self._interceptor) # type: ignore + + @property + def update_ssh_public_key(self) -> Callable[ + [oslogin.UpdateSshPublicKeyRequest], + common.SshPublicKey]: + # 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._UpdateSshPublicKey(self._session, self._host, self._interceptor) # type: ignore + + @property + def kind(self) -> str: + return "rest" + + def close(self): + self._session.close() + + +__all__=( + 'OsLoginServiceRestTransport', +) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/__init__.py new file mode 100644 index 000000000000..331a54120882 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 .oslogin import ( + CreateSshPublicKeyRequest, + DeletePosixAccountRequest, + DeleteSshPublicKeyRequest, + GetLoginProfileRequest, + GetSshPublicKeyRequest, + ImportSshPublicKeyRequest, + ImportSshPublicKeyResponse, + LoginProfile, + UpdateSshPublicKeyRequest, +) + +__all__ = ( + 'CreateSshPublicKeyRequest', + 'DeletePosixAccountRequest', + 'DeleteSshPublicKeyRequest', + 'GetLoginProfileRequest', + 'GetSshPublicKeyRequest', + 'ImportSshPublicKeyRequest', + 'ImportSshPublicKeyResponse', + 'LoginProfile', + 'UpdateSshPublicKeyRequest', +) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/oslogin.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/oslogin.py new file mode 100644 index 000000000000..0450289b7482 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/oslogin.py @@ -0,0 +1,271 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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.oslogin.common.types import common +from google.protobuf import field_mask_pb2 # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.oslogin.v1', + manifest={ + 'LoginProfile', + 'CreateSshPublicKeyRequest', + 'DeletePosixAccountRequest', + 'DeleteSshPublicKeyRequest', + 'GetLoginProfileRequest', + 'GetSshPublicKeyRequest', + 'ImportSshPublicKeyRequest', + 'ImportSshPublicKeyResponse', + 'UpdateSshPublicKeyRequest', + }, +) + + +class LoginProfile(proto.Message): + r"""The user profile information used for logging in to a virtual + machine on Google Compute Engine. + + Attributes: + name (str): + Required. A unique user ID. + posix_accounts (MutableSequence[google.cloud.oslogin.common.types.PosixAccount]): + The list of POSIX accounts associated with + the user. + ssh_public_keys (MutableMapping[str, google.cloud.oslogin.common.types.SshPublicKey]): + A map from SSH public key fingerprint to the + associated key object. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + posix_accounts: MutableSequence[common.PosixAccount] = proto.RepeatedField( + proto.MESSAGE, + number=2, + message=common.PosixAccount, + ) + ssh_public_keys: MutableMapping[str, common.SshPublicKey] = proto.MapField( + proto.STRING, + proto.MESSAGE, + number=3, + message=common.SshPublicKey, + ) + + +class CreateSshPublicKeyRequest(proto.Message): + r"""A request message for creating an SSH public key. + + Attributes: + parent (str): + Required. The unique ID for the user in format + ``users/{user}``. + ssh_public_key (google.cloud.oslogin.common.types.SshPublicKey): + Required. The SSH public key and expiration + time. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + ssh_public_key: common.SshPublicKey = proto.Field( + proto.MESSAGE, + number=2, + message=common.SshPublicKey, + ) + + +class DeletePosixAccountRequest(proto.Message): + r"""A request message for deleting a POSIX account entry. + + Attributes: + name (str): + Required. A reference to the POSIX account to update. POSIX + accounts are identified by the project ID they are + associated with. A reference to the POSIX account is in + format ``users/{user}/projects/{project}``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class DeleteSshPublicKeyRequest(proto.Message): + r"""A request message for deleting an SSH public key. + + Attributes: + name (str): + Required. The fingerprint of the public key to update. + Public keys are identified by their SHA-256 fingerprint. The + fingerprint of the public key is in format + ``users/{user}/sshPublicKeys/{fingerprint}``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class GetLoginProfileRequest(proto.Message): + r"""A request message for retrieving the login profile + information for a user. + + Attributes: + name (str): + Required. The unique ID for the user in format + ``users/{user}``. + project_id (str): + The project ID of the Google Cloud Platform + project. + system_id (str): + A system ID for filtering the results of the + request. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + project_id: str = proto.Field( + proto.STRING, + number=2, + ) + system_id: str = proto.Field( + proto.STRING, + number=3, + ) + + +class GetSshPublicKeyRequest(proto.Message): + r"""A request message for retrieving an SSH public key. + + Attributes: + name (str): + Required. The fingerprint of the public key to retrieve. + Public keys are identified by their SHA-256 fingerprint. The + fingerprint of the public key is in format + ``users/{user}/sshPublicKeys/{fingerprint}``. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + + +class ImportSshPublicKeyRequest(proto.Message): + r"""A request message for importing an SSH public key. + + Attributes: + parent (str): + Required. The unique ID for the user in format + ``users/{user}``. + ssh_public_key (google.cloud.oslogin.common.types.SshPublicKey): + Optional. The SSH public key and expiration + time. + project_id (str): + The project ID of the Google Cloud Platform + project. + regions (MutableSequence[str]): + Optional. The regions to which to assert that + the key was written. If unspecified, defaults to + all regions. Regions are listed at + https://cloud.google.com/about/locations#region. + """ + + parent: str = proto.Field( + proto.STRING, + number=1, + ) + ssh_public_key: common.SshPublicKey = proto.Field( + proto.MESSAGE, + number=2, + message=common.SshPublicKey, + ) + project_id: str = proto.Field( + proto.STRING, + number=3, + ) + regions: MutableSequence[str] = proto.RepeatedField( + proto.STRING, + number=5, + ) + + +class ImportSshPublicKeyResponse(proto.Message): + r"""A response message for importing an SSH public key. + + Attributes: + login_profile (google.cloud.oslogin_v1.types.LoginProfile): + The login profile information for the user. + details (str): + Detailed information about import results. + """ + + login_profile: 'LoginProfile' = proto.Field( + proto.MESSAGE, + number=1, + message='LoginProfile', + ) + details: str = proto.Field( + proto.STRING, + number=2, + ) + + +class UpdateSshPublicKeyRequest(proto.Message): + r"""A request message for updating an SSH public key. + + Attributes: + name (str): + Required. The fingerprint of the public key to update. + Public keys are identified by their SHA-256 fingerprint. The + fingerprint of the public key is in format + ``users/{user}/sshPublicKeys/{fingerprint}``. + ssh_public_key (google.cloud.oslogin.common.types.SshPublicKey): + Required. The SSH public key and expiration + time. + update_mask (google.protobuf.field_mask_pb2.FieldMask): + Mask to control which fields get updated. + Updates all if not present. + """ + + name: str = proto.Field( + proto.STRING, + number=1, + ) + ssh_public_key: common.SshPublicKey = proto.Field( + proto.MESSAGE, + number=2, + message=common.SshPublicKey, + ) + update_mask: field_mask_pb2.FieldMask = proto.Field( + proto.MESSAGE, + number=3, + message=field_mask_pb2.FieldMask, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-cloud-os-login/v1/mypy.ini b/owl-bot-staging/google-cloud-os-login/v1/mypy.ini new file mode 100644 index 000000000000..574c5aed394b --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.7 +namespace_packages = True diff --git a/owl-bot-staging/google-cloud-os-login/v1/noxfile.py b/owl-bot-staging/google-cloud-os-login/v1/noxfile.py new file mode 100644 index 000000000000..77d33bf87156 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/noxfile.py @@ -0,0 +1,253 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 re +import shutil +import subprocess +import sys + + +import nox # type: ignore + +ALL_PYTHON = [ + "3.7", + "3.8", + "3.9", + "3.10", + "3.11", + "3.12" +] + +CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() + +LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" +PACKAGE_NAME = 'google-cloud-os-login' + +BLACK_VERSION = "black==22.3.0" +BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] +DEFAULT_PYTHON_VERSION = "3.12" + +nox.sessions = [ + "unit", + "cover", + "mypy", + "check_lower_bounds" + # exclude update_lower_bounds from default + "docs", + "blacken", + "lint", + "prerelease_deps", +] + +@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/oslogin_v1/', + '--cov=tests/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + +@nox.session(python=ALL_PYTHON[-1]) +def prerelease_deps(session): + """Run the unit test suite against pre-release versions of dependencies.""" + + # Install test environment dependencies + session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') + + # Install the package without dependencies + session.install('-e', '.', '--no-deps') + + # We test the minimum dependency versions using the minimum Python + # version so the lowest python runtime that we test has a corresponding constraints + # file, located at `testing/constraints--.txt`, which contains all of the + # dependencies and extras. + with open( + CURRENT_DIRECTORY + / "testing" + / f"constraints-{ALL_PYTHON[0]}.txt", + encoding="utf-8", + ) as constraints_file: + constraints_text = constraints_file.read() + + # Ignore leading whitespace and comment lines. + constraints_deps = [ + match.group(1) + for match in re.finditer( + r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE + ) + ] + + session.install(*constraints_deps) + + prerel_deps = [ + "googleapis-common-protos", + "google-api-core", + "google-auth", + "grpcio", + "grpcio-status", + "protobuf", + "proto-plus", + ] + + for dep in prerel_deps: + session.install("--pre", "--no-deps", "--upgrade", dep) + + # Remaining dependencies + other_deps = [ + "requests", + ] + session.install(*other_deps) + + # Print out prerelease package versions + + session.run("python", "-c", "import google.api_core; print(google.api_core.__version__)") + session.run("python", "-c", "import google.auth; print(google.auth.__version__)") + session.run("python", "-c", "import grpc; print(grpc.__version__)") + session.run( + "python", "-c", "import google.protobuf; print(google.protobuf.__version__)" + ) + session.run( + "python", "-c", "import proto; print(proto.__version__)" + ) + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/oslogin_v1/', + '--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', + '-p', + '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==7.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, + ) diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_async.py new file mode 100644 index 000000000000..d3579bbd7a15 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 CreateSshPublicKey +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_CreateSshPublicKey_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 oslogin_v1 + + +async def sample_create_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.CreateSshPublicKeyRequest( + parent="parent_value", + ) + + # Make the request + response = await client.create_ssh_public_key(request=request) + + # Handle the response + print(response) + +# [END oslogin_v1_generated_OsLoginService_CreateSshPublicKey_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_sync.py new file mode 100644 index 000000000000..ee1e2117bf43 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 CreateSshPublicKey +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_CreateSshPublicKey_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 oslogin_v1 + + +def sample_create_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.CreateSshPublicKeyRequest( + parent="parent_value", + ) + + # Make the request + response = client.create_ssh_public_key(request=request) + + # Handle the response + print(response) + +# [END oslogin_v1_generated_OsLoginService_CreateSshPublicKey_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_async.py new file mode 100644 index 000000000000..ee50ecc45d35 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_async.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 DeletePosixAccount +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_DeletePosixAccount_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 oslogin_v1 + + +async def sample_delete_posix_account(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.DeletePosixAccountRequest( + name="name_value", + ) + + # Make the request + await client.delete_posix_account(request=request) + + +# [END oslogin_v1_generated_OsLoginService_DeletePosixAccount_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_sync.py new file mode 100644 index 000000000000..f21e23eec73c --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_sync.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 DeletePosixAccount +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_DeletePosixAccount_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 oslogin_v1 + + +def sample_delete_posix_account(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.DeletePosixAccountRequest( + name="name_value", + ) + + # Make the request + client.delete_posix_account(request=request) + + +# [END oslogin_v1_generated_OsLoginService_DeletePosixAccount_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_async.py new file mode 100644 index 000000000000..82ba6ac0d53b --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_async.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 DeleteSshPublicKey +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_DeleteSshPublicKey_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 oslogin_v1 + + +async def sample_delete_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.DeleteSshPublicKeyRequest( + name="name_value", + ) + + # Make the request + await client.delete_ssh_public_key(request=request) + + +# [END oslogin_v1_generated_OsLoginService_DeleteSshPublicKey_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_sync.py new file mode 100644 index 000000000000..7b127f8dad37 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_sync.py @@ -0,0 +1,50 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 DeleteSshPublicKey +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_DeleteSshPublicKey_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 oslogin_v1 + + +def sample_delete_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.DeleteSshPublicKeyRequest( + name="name_value", + ) + + # Make the request + client.delete_ssh_public_key(request=request) + + +# [END oslogin_v1_generated_OsLoginService_DeleteSshPublicKey_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_async.py new file mode 100644 index 000000000000..05b9bc022cc8 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 GetLoginProfile +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_GetLoginProfile_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 oslogin_v1 + + +async def sample_get_login_profile(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.GetLoginProfileRequest( + name="name_value", + ) + + # Make the request + response = await client.get_login_profile(request=request) + + # Handle the response + print(response) + +# [END oslogin_v1_generated_OsLoginService_GetLoginProfile_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_sync.py new file mode 100644 index 000000000000..49db40965d5e --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 GetLoginProfile +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_GetLoginProfile_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 oslogin_v1 + + +def sample_get_login_profile(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.GetLoginProfileRequest( + name="name_value", + ) + + # Make the request + response = client.get_login_profile(request=request) + + # Handle the response + print(response) + +# [END oslogin_v1_generated_OsLoginService_GetLoginProfile_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_async.py new file mode 100644 index 000000000000..fff1105c0c2d --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 GetSshPublicKey +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_GetSshPublicKey_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 oslogin_v1 + + +async def sample_get_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.GetSshPublicKeyRequest( + name="name_value", + ) + + # Make the request + response = await client.get_ssh_public_key(request=request) + + # Handle the response + print(response) + +# [END oslogin_v1_generated_OsLoginService_GetSshPublicKey_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_sync.py new file mode 100644 index 000000000000..b20fb7c0849a --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 GetSshPublicKey +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_GetSshPublicKey_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 oslogin_v1 + + +def sample_get_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.GetSshPublicKeyRequest( + name="name_value", + ) + + # Make the request + response = client.get_ssh_public_key(request=request) + + # Handle the response + print(response) + +# [END oslogin_v1_generated_OsLoginService_GetSshPublicKey_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_async.py new file mode 100644 index 000000000000..00e4c918453c --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 ImportSshPublicKey +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_ImportSshPublicKey_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 oslogin_v1 + + +async def sample_import_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.ImportSshPublicKeyRequest( + parent="parent_value", + ) + + # Make the request + response = await client.import_ssh_public_key(request=request) + + # Handle the response + print(response) + +# [END oslogin_v1_generated_OsLoginService_ImportSshPublicKey_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_sync.py new file mode 100644 index 000000000000..7db23783c243 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 ImportSshPublicKey +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_ImportSshPublicKey_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 oslogin_v1 + + +def sample_import_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.ImportSshPublicKeyRequest( + parent="parent_value", + ) + + # Make the request + response = client.import_ssh_public_key(request=request) + + # Handle the response + print(response) + +# [END oslogin_v1_generated_OsLoginService_ImportSshPublicKey_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_async.py new file mode 100644 index 000000000000..a37078b26198 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_async.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 UpdateSshPublicKey +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_UpdateSshPublicKey_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 oslogin_v1 + + +async def sample_update_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceAsyncClient() + + # Initialize request argument(s) + request = oslogin_v1.UpdateSshPublicKeyRequest( + name="name_value", + ) + + # Make the request + response = await client.update_ssh_public_key(request=request) + + # Handle the response + print(response) + +# [END oslogin_v1_generated_OsLoginService_UpdateSshPublicKey_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_sync.py new file mode 100644 index 000000000000..c800ff02d601 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_sync.py @@ -0,0 +1,52 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 UpdateSshPublicKey +# 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-os-login + + +# [START oslogin_v1_generated_OsLoginService_UpdateSshPublicKey_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 oslogin_v1 + + +def sample_update_ssh_public_key(): + # Create a client + client = oslogin_v1.OsLoginServiceClient() + + # Initialize request argument(s) + request = oslogin_v1.UpdateSshPublicKeyRequest( + name="name_value", + ) + + # Make the request + response = client.update_ssh_public_key(request=request) + + # Handle the response + print(response) + +# [END oslogin_v1_generated_OsLoginService_UpdateSshPublicKey_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/snippet_metadata_google.cloud.oslogin.v1.json b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/snippet_metadata_google.cloud.oslogin.v1.json new file mode 100644 index 000000000000..92b367f767a3 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/snippet_metadata_google.cloud.oslogin.v1.json @@ -0,0 +1,1170 @@ +{ + "clientLibrary": { + "apis": [ + { + "id": "google.cloud.oslogin.v1", + "version": "v1" + } + ], + "language": "PYTHON", + "name": "google-cloud-os-login", + "version": "0.1.0" + }, + "snippets": [ + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", + "shortName": "OsLoginServiceAsyncClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.create_ssh_public_key", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.CreateSshPublicKey", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "CreateSshPublicKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.CreateSshPublicKeyRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "ssh_public_key", + "type": "google.cloud.oslogin.common.types.SshPublicKey" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.oslogin.common.types.SshPublicKey", + "shortName": "create_ssh_public_key" + }, + "description": "Sample for CreateSshPublicKey", + "file": "oslogin_v1_generated_os_login_service_create_ssh_public_key_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_CreateSshPublicKey_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": "oslogin_v1_generated_os_login_service_create_ssh_public_key_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", + "shortName": "OsLoginServiceClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.create_ssh_public_key", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.CreateSshPublicKey", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "CreateSshPublicKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.CreateSshPublicKeyRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "ssh_public_key", + "type": "google.cloud.oslogin.common.types.SshPublicKey" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.oslogin.common.types.SshPublicKey", + "shortName": "create_ssh_public_key" + }, + "description": "Sample for CreateSshPublicKey", + "file": "oslogin_v1_generated_os_login_service_create_ssh_public_key_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_CreateSshPublicKey_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": "oslogin_v1_generated_os_login_service_create_ssh_public_key_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", + "shortName": "OsLoginServiceAsyncClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.delete_posix_account", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.DeletePosixAccount", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "DeletePosixAccount" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.DeletePosixAccountRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_posix_account" + }, + "description": "Sample for DeletePosixAccount", + "file": "oslogin_v1_generated_os_login_service_delete_posix_account_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_DeletePosixAccount_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "oslogin_v1_generated_os_login_service_delete_posix_account_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", + "shortName": "OsLoginServiceClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.delete_posix_account", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.DeletePosixAccount", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "DeletePosixAccount" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.DeletePosixAccountRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_posix_account" + }, + "description": "Sample for DeletePosixAccount", + "file": "oslogin_v1_generated_os_login_service_delete_posix_account_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_DeletePosixAccount_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "oslogin_v1_generated_os_login_service_delete_posix_account_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", + "shortName": "OsLoginServiceAsyncClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.delete_ssh_public_key", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.DeleteSshPublicKey", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "DeleteSshPublicKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_ssh_public_key" + }, + "description": "Sample for DeleteSshPublicKey", + "file": "oslogin_v1_generated_os_login_service_delete_ssh_public_key_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_DeleteSshPublicKey_async", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "oslogin_v1_generated_os_login_service_delete_ssh_public_key_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", + "shortName": "OsLoginServiceClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.delete_ssh_public_key", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.DeleteSshPublicKey", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "DeleteSshPublicKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "shortName": "delete_ssh_public_key" + }, + "description": "Sample for DeleteSshPublicKey", + "file": "oslogin_v1_generated_os_login_service_delete_ssh_public_key_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_DeleteSshPublicKey_sync", + "segments": [ + { + "end": 49, + "start": 27, + "type": "FULL" + }, + { + "end": 49, + "start": 27, + "type": "SHORT" + }, + { + "end": 40, + "start": 38, + "type": "CLIENT_INITIALIZATION" + }, + { + "end": 45, + "start": 41, + "type": "REQUEST_INITIALIZATION" + }, + { + "start": 46, + "type": "REQUEST_EXECUTION" + }, + { + "end": 50, + "type": "RESPONSE_HANDLING" + } + ], + "title": "oslogin_v1_generated_os_login_service_delete_ssh_public_key_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", + "shortName": "OsLoginServiceAsyncClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.get_login_profile", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.GetLoginProfile", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "GetLoginProfile" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.GetLoginProfileRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.oslogin_v1.types.LoginProfile", + "shortName": "get_login_profile" + }, + "description": "Sample for GetLoginProfile", + "file": "oslogin_v1_generated_os_login_service_get_login_profile_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_GetLoginProfile_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": "oslogin_v1_generated_os_login_service_get_login_profile_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", + "shortName": "OsLoginServiceClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.get_login_profile", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.GetLoginProfile", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "GetLoginProfile" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.GetLoginProfileRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.oslogin_v1.types.LoginProfile", + "shortName": "get_login_profile" + }, + "description": "Sample for GetLoginProfile", + "file": "oslogin_v1_generated_os_login_service_get_login_profile_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_GetLoginProfile_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": "oslogin_v1_generated_os_login_service_get_login_profile_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", + "shortName": "OsLoginServiceAsyncClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.get_ssh_public_key", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.GetSshPublicKey", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "GetSshPublicKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.GetSshPublicKeyRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.oslogin.common.types.SshPublicKey", + "shortName": "get_ssh_public_key" + }, + "description": "Sample for GetSshPublicKey", + "file": "oslogin_v1_generated_os_login_service_get_ssh_public_key_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_GetSshPublicKey_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": "oslogin_v1_generated_os_login_service_get_ssh_public_key_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", + "shortName": "OsLoginServiceClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.get_ssh_public_key", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.GetSshPublicKey", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "GetSshPublicKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.GetSshPublicKeyRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.oslogin.common.types.SshPublicKey", + "shortName": "get_ssh_public_key" + }, + "description": "Sample for GetSshPublicKey", + "file": "oslogin_v1_generated_os_login_service_get_ssh_public_key_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_GetSshPublicKey_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": "oslogin_v1_generated_os_login_service_get_ssh_public_key_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", + "shortName": "OsLoginServiceAsyncClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.import_ssh_public_key", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.ImportSshPublicKey", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "ImportSshPublicKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "ssh_public_key", + "type": "google.cloud.oslogin.common.types.SshPublicKey" + }, + { + "name": "project_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.oslogin_v1.types.ImportSshPublicKeyResponse", + "shortName": "import_ssh_public_key" + }, + "description": "Sample for ImportSshPublicKey", + "file": "oslogin_v1_generated_os_login_service_import_ssh_public_key_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_ImportSshPublicKey_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": "oslogin_v1_generated_os_login_service_import_ssh_public_key_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", + "shortName": "OsLoginServiceClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.import_ssh_public_key", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.ImportSshPublicKey", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "ImportSshPublicKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest" + }, + { + "name": "parent", + "type": "str" + }, + { + "name": "ssh_public_key", + "type": "google.cloud.oslogin.common.types.SshPublicKey" + }, + { + "name": "project_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.oslogin_v1.types.ImportSshPublicKeyResponse", + "shortName": "import_ssh_public_key" + }, + "description": "Sample for ImportSshPublicKey", + "file": "oslogin_v1_generated_os_login_service_import_ssh_public_key_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_ImportSshPublicKey_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": "oslogin_v1_generated_os_login_service_import_ssh_public_key_sync.py" + }, + { + "canonical": true, + "clientMethod": { + "async": true, + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", + "shortName": "OsLoginServiceAsyncClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.update_ssh_public_key", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.UpdateSshPublicKey", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "UpdateSshPublicKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "ssh_public_key", + "type": "google.cloud.oslogin.common.types.SshPublicKey" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.oslogin.common.types.SshPublicKey", + "shortName": "update_ssh_public_key" + }, + "description": "Sample for UpdateSshPublicKey", + "file": "oslogin_v1_generated_os_login_service_update_ssh_public_key_async.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_UpdateSshPublicKey_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": "oslogin_v1_generated_os_login_service_update_ssh_public_key_async.py" + }, + { + "canonical": true, + "clientMethod": { + "client": { + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", + "shortName": "OsLoginServiceClient" + }, + "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.update_ssh_public_key", + "method": { + "fullName": "google.cloud.oslogin.v1.OsLoginService.UpdateSshPublicKey", + "service": { + "fullName": "google.cloud.oslogin.v1.OsLoginService", + "shortName": "OsLoginService" + }, + "shortName": "UpdateSshPublicKey" + }, + "parameters": [ + { + "name": "request", + "type": "google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest" + }, + { + "name": "name", + "type": "str" + }, + { + "name": "ssh_public_key", + "type": "google.cloud.oslogin.common.types.SshPublicKey" + }, + { + "name": "update_mask", + "type": "google.protobuf.field_mask_pb2.FieldMask" + }, + { + "name": "retry", + "type": "google.api_core.retry.Retry" + }, + { + "name": "timeout", + "type": "float" + }, + { + "name": "metadata", + "type": "Sequence[Tuple[str, str]" + } + ], + "resultType": "google.cloud.oslogin.common.types.SshPublicKey", + "shortName": "update_ssh_public_key" + }, + "description": "Sample for UpdateSshPublicKey", + "file": "oslogin_v1_generated_os_login_service_update_ssh_public_key_sync.py", + "language": "PYTHON", + "origin": "API_DEFINITION", + "regionTag": "oslogin_v1_generated_OsLoginService_UpdateSshPublicKey_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": "oslogin_v1_generated_os_login_service_update_ssh_public_key_sync.py" + } + ] +} diff --git a/owl-bot-staging/google-cloud-os-login/v1/scripts/fixup_oslogin_v1_keywords.py b/owl-bot-staging/google-cloud-os-login/v1/scripts/fixup_oslogin_v1_keywords.py new file mode 100644 index 000000000000..62869d14c125 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/scripts/fixup_oslogin_v1_keywords.py @@ -0,0 +1,182 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 osloginCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + 'create_ssh_public_key': ('parent', 'ssh_public_key', ), + 'delete_posix_account': ('name', ), + 'delete_ssh_public_key': ('name', ), + 'get_login_profile': ('name', 'project_id', 'system_id', ), + 'get_ssh_public_key': ('name', ), + 'import_ssh_public_key': ('parent', 'ssh_public_key', 'project_id', 'regions', ), + 'update_ssh_public_key': ('name', 'ssh_public_key', 'update_mask', ), + } + + 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=osloginCallTransformer(), +): + """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 oslogin 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/google-cloud-os-login/v1/setup.py b/owl-bot-staging/google-cloud-os-login/v1/setup.py new file mode 100644 index 000000000000..92482281d8bf --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/setup.py @@ -0,0 +1,93 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 re + +import setuptools # type: ignore + +package_root = os.path.abspath(os.path.dirname(__file__)) + +name = 'google-cloud-os-login' + + +description = "Google Cloud Os Login API client library" + +version = None + +with open(os.path.join(package_root, 'google/cloud/oslogin/gapic_version.py')) as fp: + version_candidates = re.findall(r"(?<=\")\d+.\d+.\d+(?=\")", fp.read()) + assert (len(version_candidates) == 1) + version = version_candidates[0] + +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.1, <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.*", + # Exclude incompatible versions of `google-auth` + # See https://github.com/googleapis/google-cloud-python/issues/12364 + "google-auth >= 2.14.1, <3.0.0dev,!=2.24.0,!=2.25.0", + "proto-plus >= 1.22.3, <2.0.0dev", + "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/google-cloud-python/tree/main/packages/google-cloud-os-login" + +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.find_namespace_packages() + if package.startswith("google") +] + +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", + "Programming Language :: Python :: 3.12", + "Operating System :: OS Independent", + "Topic :: Internet", + ], + platforms="Posix; MacOS X; Windows", + packages=packages, + python_requires=">=3.7", + install_requires=dependencies, + include_package_data=True, + zip_safe=False, +) diff --git a/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.10.txt b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.10.txt new file mode 100644 index 000000000000..ed7f9aed2559 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/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/google-cloud-os-login/v1/testing/constraints-3.11.txt b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.11.txt new file mode 100644 index 000000000000..ed7f9aed2559 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/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/google-cloud-os-login/v1/testing/constraints-3.12.txt b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.12.txt new file mode 100644 index 000000000000..ed7f9aed2559 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/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/google-cloud-os-login/v1/testing/constraints-3.7.txt b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.7.txt new file mode 100644 index 000000000000..b8a550c73855 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.7.txt @@ -0,0 +1,10 @@ +# 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.1 +google-auth==2.14.1 +proto-plus==1.22.3 +protobuf==3.19.5 diff --git a/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.8.txt b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.8.txt new file mode 100644 index 000000000000..ed7f9aed2559 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/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/google-cloud-os-login/v1/testing/constraints-3.9.txt b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.9.txt new file mode 100644 index 000000000000..ed7f9aed2559 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/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/google-cloud-os-login/v1/tests/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/tests/__init__.py new file mode 100644 index 000000000000..7b3de3117f38 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/tests/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/google-cloud-os-login/v1/tests/unit/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/tests/unit/__init__.py new file mode 100644 index 000000000000..7b3de3117f38 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/tests/unit/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/google-cloud-os-login/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/__init__.py new file mode 100644 index 000000000000..7b3de3117f38 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/__init__.py new file mode 100644 index 000000000000..7b3de3117f38 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/__init__.py @@ -0,0 +1,16 @@ + +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py b/owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py new file mode 100644 index 000000000000..dcc731d785a4 --- /dev/null +++ b/owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py @@ -0,0 +1,6129 @@ +# -*- coding: utf-8 -*- +# Copyright 2024 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 google.api_core import api_core_version +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.oslogin.common.types import common +from google.cloud.oslogin_v1.services.os_login_service import OsLoginServiceAsyncClient +from google.cloud.oslogin_v1.services.os_login_service import OsLoginServiceClient +from google.cloud.oslogin_v1.services.os_login_service import transports +from google.cloud.oslogin_v1.types import oslogin +from google.oauth2 import service_account +from google.protobuf import field_mask_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 + +# If default endpoint template is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint template so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint_template(client): + return "test.{UNIVERSE_DOMAIN}" if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) else client._DEFAULT_ENDPOINT_TEMPLATE + + +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 OsLoginServiceClient._get_default_mtls_endpoint(None) is None + assert OsLoginServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint + assert OsLoginServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint + assert OsLoginServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint + assert OsLoginServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint + assert OsLoginServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi + +def test__read_environment_variables(): + assert OsLoginServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + assert OsLoginServiceClient._read_environment_variables() == (True, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): + assert OsLoginServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError) as excinfo: + OsLoginServiceClient._read_environment_variables() + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + assert OsLoginServiceClient._read_environment_variables() == (False, "never", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + assert OsLoginServiceClient._read_environment_variables() == (False, "always", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): + assert OsLoginServiceClient._read_environment_variables() == (False, "auto", None) + + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError) as excinfo: + OsLoginServiceClient._read_environment_variables() + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): + assert OsLoginServiceClient._read_environment_variables() == (False, "auto", "foo.com") + +def test__get_client_cert_source(): + mock_provided_cert_source = mock.Mock() + mock_default_cert_source = mock.Mock() + + assert OsLoginServiceClient._get_client_cert_source(None, False) is None + assert OsLoginServiceClient._get_client_cert_source(mock_provided_cert_source, False) is None + assert OsLoginServiceClient._get_client_cert_source(mock_provided_cert_source, True) == mock_provided_cert_source + + 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_default_cert_source): + assert OsLoginServiceClient._get_client_cert_source(None, True) is mock_default_cert_source + assert OsLoginServiceClient._get_client_cert_source(mock_provided_cert_source, "true") is mock_provided_cert_source + +@mock.patch.object(OsLoginServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceClient)) +@mock.patch.object(OsLoginServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceAsyncClient)) +def test__get_api_endpoint(): + api_override = "foo.com" + mock_client_cert_source = mock.Mock() + default_universe = OsLoginServiceClient._DEFAULT_UNIVERSE + default_endpoint = OsLoginServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) + mock_universe = "bar.com" + mock_endpoint = OsLoginServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) + + assert OsLoginServiceClient._get_api_endpoint(api_override, mock_client_cert_source, default_universe, "always") == api_override + assert OsLoginServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "auto") == OsLoginServiceClient.DEFAULT_MTLS_ENDPOINT + assert OsLoginServiceClient._get_api_endpoint(None, None, default_universe, "auto") == default_endpoint + assert OsLoginServiceClient._get_api_endpoint(None, None, default_universe, "always") == OsLoginServiceClient.DEFAULT_MTLS_ENDPOINT + assert OsLoginServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "always") == OsLoginServiceClient.DEFAULT_MTLS_ENDPOINT + assert OsLoginServiceClient._get_api_endpoint(None, None, mock_universe, "never") == mock_endpoint + assert OsLoginServiceClient._get_api_endpoint(None, None, default_universe, "never") == default_endpoint + + with pytest.raises(MutualTLSChannelError) as excinfo: + OsLoginServiceClient._get_api_endpoint(None, mock_client_cert_source, mock_universe, "auto") + assert str(excinfo.value) == "mTLS is not supported in any universe other than googleapis.com." + + +def test__get_universe_domain(): + client_universe_domain = "foo.com" + universe_domain_env = "bar.com" + + assert OsLoginServiceClient._get_universe_domain(client_universe_domain, universe_domain_env) == client_universe_domain + assert OsLoginServiceClient._get_universe_domain(None, universe_domain_env) == universe_domain_env + assert OsLoginServiceClient._get_universe_domain(None, None) == OsLoginServiceClient._DEFAULT_UNIVERSE + + with pytest.raises(ValueError) as excinfo: + OsLoginServiceClient._get_universe_domain("", None) + assert str(excinfo.value) == "Universe Domain cannot be an empty string." + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc"), + (OsLoginServiceClient, transports.OsLoginServiceRestTransport, "rest"), +]) +def test__validate_universe_domain(client_class, transport_class, transport_name): + client = client_class( + transport=transport_class( + credentials=ga_credentials.AnonymousCredentials() + ) + ) + assert client._validate_universe_domain() == True + + # Test the case when universe is already validated. + assert client._validate_universe_domain() == True + + if transport_name == "grpc": + # Test the case where credentials are provided by the + # `local_channel_credentials`. The default universes in both match. + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + client = client_class(transport=transport_class(channel=channel)) + assert client._validate_universe_domain() == True + + # Test the case where credentials do not exist: e.g. a transport is provided + # with no credentials. Validation should still succeed because there is no + # mismatch with non-existent credentials. + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + transport=transport_class(channel=channel) + transport._credentials = None + client = client_class(transport=transport) + assert client._validate_universe_domain() == True + + # TODO: This is needed to cater for older versions of google-auth + # Make this test unconditional once the minimum supported version of + # google-auth becomes 2.23.0 or higher. + google_auth_major, google_auth_minor = [int(part) for part in google.auth.__version__.split(".")[0:2]] + if google_auth_major > 2 or (google_auth_major == 2 and google_auth_minor >= 23): + credentials = ga_credentials.AnonymousCredentials() + credentials._universe_domain = "foo.com" + # Test the case when there is a universe mismatch from the credentials. + client = client_class( + transport=transport_class(credentials=credentials) + ) + with pytest.raises(ValueError) as excinfo: + client._validate_universe_domain() + assert str(excinfo.value) == "The configured universe domain (googleapis.com) does not match the universe domain found in the credentials (foo.com). If you haven't configured the universe domain explicitly, `googleapis.com` is the default." + + # Test the case when there is a universe mismatch from the client. + # + # TODO: Make this test unconditional once the minimum supported version of + # google-api-core becomes 2.15.0 or higher. + api_core_major, api_core_minor = [int(part) for part in api_core_version.__version__.split(".")[0:2]] + if api_core_major > 2 or (api_core_major == 2 and api_core_minor >= 15): + client = client_class(client_options={"universe_domain": "bar.com"}, transport=transport_class(credentials=ga_credentials.AnonymousCredentials(),)) + with pytest.raises(ValueError) as excinfo: + client._validate_universe_domain() + assert str(excinfo.value) == "The configured universe domain (bar.com) does not match the universe domain found in the credentials (googleapis.com). If you haven't configured the universe domain explicitly, `googleapis.com` is the default." + + # Test that ValueError is raised if universe_domain is provided via client options and credentials is None + with pytest.raises(ValueError): + client._compare_universes("foo.bar", None) + + +@pytest.mark.parametrize("client_class,transport_name", [ + (OsLoginServiceClient, "grpc"), + (OsLoginServiceAsyncClient, "grpc_asyncio"), + (OsLoginServiceClient, "rest"), +]) +def test_os_login_service_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 == ( + 'oslogin.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://oslogin.googleapis.com' + ) + + +@pytest.mark.parametrize("transport_class,transport_name", [ + (transports.OsLoginServiceGrpcTransport, "grpc"), + (transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (transports.OsLoginServiceRestTransport, "rest"), +]) +def test_os_login_service_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", [ + (OsLoginServiceClient, "grpc"), + (OsLoginServiceAsyncClient, "grpc_asyncio"), + (OsLoginServiceClient, "rest"), +]) +def test_os_login_service_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 == ( + 'oslogin.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else + 'https://oslogin.googleapis.com' + ) + + +def test_os_login_service_client_get_transport_class(): + transport = OsLoginServiceClient.get_transport_class() + available_transports = [ + transports.OsLoginServiceGrpcTransport, + transports.OsLoginServiceRestTransport, + ] + assert transport in available_transports + + transport = OsLoginServiceClient.get_transport_class("grpc") + assert transport == transports.OsLoginServiceGrpcTransport + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc"), + (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (OsLoginServiceClient, transports.OsLoginServiceRestTransport, "rest"), +]) +@mock.patch.object(OsLoginServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceClient)) +@mock.patch.object(OsLoginServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceAsyncClient)) +def test_os_login_service_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(OsLoginServiceClient, '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(OsLoginServiceClient, '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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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) as excinfo: + client = client_class(transport=transport_name) + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + # 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) as excinfo: + client = client_class(transport=transport_name) + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + + # 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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", [ + (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc", "true"), + (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), + (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc", "false"), + (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), + (OsLoginServiceClient, transports.OsLoginServiceRestTransport, "rest", "true"), + (OsLoginServiceClient, transports.OsLoginServiceRestTransport, "rest", "false"), +]) +@mock.patch.object(OsLoginServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceClient)) +@mock.patch.object(OsLoginServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceAsyncClient)) +@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) +def test_os_login_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) + 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) + 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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", [ + OsLoginServiceClient, OsLoginServiceAsyncClient +]) +@mock.patch.object(OsLoginServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OsLoginServiceClient)) +@mock.patch.object(OsLoginServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OsLoginServiceAsyncClient)) +def test_os_login_service_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 + + # 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) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" + + # 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) as excinfo: + client_class.get_mtls_endpoint_and_cert_source() + + assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" + +@pytest.mark.parametrize("client_class", [ + OsLoginServiceClient, OsLoginServiceAsyncClient +]) +@mock.patch.object(OsLoginServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceClient)) +@mock.patch.object(OsLoginServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceAsyncClient)) +def test_os_login_service_client_client_api_endpoint(client_class): + mock_client_cert_source = client_cert_source_callback + api_override = "foo.com" + default_universe = OsLoginServiceClient._DEFAULT_UNIVERSE + default_endpoint = OsLoginServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) + mock_universe = "bar.com" + mock_endpoint = OsLoginServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) + + # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", + # use ClientOptions.api_endpoint as the api endpoint regardless. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): + with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel"): + options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=api_override) + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == api_override + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", + # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): + client = client_class(credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT + + # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), + # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, + # and ClientOptions.universe_domain="bar.com", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. + options = client_options.ClientOptions() + universe_exists = hasattr(options, "universe_domain") + if universe_exists: + options = client_options.ClientOptions(universe_domain=mock_universe) + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + else: + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == (mock_endpoint if universe_exists else default_endpoint) + assert client.universe_domain == (mock_universe if universe_exists else default_universe) + + # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", + # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. + options = client_options.ClientOptions() + if hasattr(options, "universe_domain"): + delattr(options, "universe_domain") + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): + client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) + assert client.api_endpoint == default_endpoint + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc"), + (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio"), + (OsLoginServiceClient, transports.OsLoginServiceRestTransport, "rest"), +]) +def test_os_login_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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", [ + (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc", grpc_helpers), + (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), + (OsLoginServiceClient, transports.OsLoginServiceRestTransport, "rest", None), +]) +def test_os_login_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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_os_login_service_client_client_options_from_dict(): + with mock.patch('google.cloud.oslogin_v1.services.os_login_service.transports.OsLoginServiceGrpcTransport.__init__') as grpc_transport: + grpc_transport.return_value = None + client = OsLoginServiceClient( + 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", [ + (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc", grpc_helpers), + (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), +]) +def test_os_login_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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( + "oslogin.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-platform.read-only', + 'https://www.googleapis.com/auth/compute', + 'https://www.googleapis.com/auth/compute.readonly', +), + scopes=None, + default_host="oslogin.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.CreateSshPublicKeyRequest, + dict, +]) +def test_create_ssh_public_key(request_type, transport: str = 'grpc'): + client = OsLoginServiceClient( + 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.create_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = common.SshPublicKey( + key='key_value', + expiration_time_usec=2144, + fingerprint='fingerprint_value', + name='name_value', + ) + response = client.create_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = oslogin.CreateSshPublicKeyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, common.SshPublicKey) + assert response.key == 'key_value' + assert response.expiration_time_usec == 2144 + assert response.fingerprint == 'fingerprint_value' + assert response.name == 'name_value' + + +def test_create_ssh_public_key_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 = OsLoginServiceClient( + 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.create_ssh_public_key), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.create_ssh_public_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.CreateSshPublicKeyRequest() + + +def test_create_ssh_public_key_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = oslogin.CreateSshPublicKeyRequest( + parent='parent_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_ssh_public_key), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.create_ssh_public_key(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.CreateSshPublicKeyRequest( + parent='parent_value', + ) + +def test_create_ssh_public_key_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_ssh_public_key in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_ssh_public_key] = mock_rpc + request = {} + client.create_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_create_ssh_public_key_empty_call_async(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey( + key='key_value', + expiration_time_usec=2144, + fingerprint='fingerprint_value', + name='name_value', + )) + response = await client.create_ssh_public_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.CreateSshPublicKeyRequest() + +@pytest.mark.asyncio +async def test_create_ssh_public_key_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.create_ssh_public_key in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + class AwaitableMock(mock.AsyncMock): + def __await__(self): + self.await_count += 1 + return iter([]) + mock_object = AwaitableMock() + client._client._transport._wrapped_methods[client._client._transport.create_ssh_public_key] = mock_object + + request = {} + await client.create_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_object.call_count == 1 + + await client.create_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_object.call_count == 2 + +@pytest.mark.asyncio +async def test_create_ssh_public_key_async(transport: str = 'grpc_asyncio', request_type=oslogin.CreateSshPublicKeyRequest): + client = OsLoginServiceAsyncClient( + 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.create_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey( + key='key_value', + expiration_time_usec=2144, + fingerprint='fingerprint_value', + name='name_value', + )) + response = await client.create_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = oslogin.CreateSshPublicKeyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, common.SshPublicKey) + assert response.key == 'key_value' + assert response.expiration_time_usec == 2144 + assert response.fingerprint == 'fingerprint_value' + assert response.name == 'name_value' + + +@pytest.mark.asyncio +async def test_create_ssh_public_key_async_from_dict(): + await test_create_ssh_public_key_async(request_type=dict) + + +def test_create_ssh_public_key_field_headers(): + client = OsLoginServiceClient( + 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 = oslogin.CreateSshPublicKeyRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_ssh_public_key), + '__call__') as call: + call.return_value = common.SshPublicKey() + client.create_ssh_public_key(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', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_create_ssh_public_key_field_headers_async(): + client = OsLoginServiceAsyncClient( + 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 = oslogin.CreateSshPublicKeyRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_ssh_public_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey()) + await client.create_ssh_public_key(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', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_create_ssh_public_key_flattened(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = common.SshPublicKey() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.create_ssh_public_key( + parent='parent_value', + ssh_public_key=common.SshPublicKey(key='key_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].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].ssh_public_key + mock_val = common.SshPublicKey(key='key_value') + assert arg == mock_val + + +def test_create_ssh_public_key_flattened_error(): + client = OsLoginServiceClient( + 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.create_ssh_public_key( + oslogin.CreateSshPublicKeyRequest(), + parent='parent_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + ) + +@pytest.mark.asyncio +async def test_create_ssh_public_key_flattened_async(): + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.create_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = common.SshPublicKey() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.create_ssh_public_key( + parent='parent_value', + ssh_public_key=common.SshPublicKey(key='key_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].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].ssh_public_key + mock_val = common.SshPublicKey(key='key_value') + assert arg == mock_val + +@pytest.mark.asyncio +async def test_create_ssh_public_key_flattened_error_async(): + client = OsLoginServiceAsyncClient( + 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.create_ssh_public_key( + oslogin.CreateSshPublicKeyRequest(), + parent='parent_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.DeletePosixAccountRequest, + dict, +]) +def test_delete_posix_account(request_type, transport: str = 'grpc'): + client = OsLoginServiceClient( + 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_posix_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_posix_account(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = oslogin.DeletePosixAccountRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_posix_account_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 = OsLoginServiceClient( + 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_posix_account), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.delete_posix_account() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.DeletePosixAccountRequest() + + +def test_delete_posix_account_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = oslogin.DeletePosixAccountRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_posix_account), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.delete_posix_account(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.DeletePosixAccountRequest( + name='name_value', + ) + +def test_delete_posix_account_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.delete_posix_account in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.delete_posix_account] = mock_rpc + request = {} + client.delete_posix_account(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_posix_account(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_delete_posix_account_empty_call_async(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_posix_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_posix_account() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.DeletePosixAccountRequest() + +@pytest.mark.asyncio +async def test_delete_posix_account_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.delete_posix_account in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + class AwaitableMock(mock.AsyncMock): + def __await__(self): + self.await_count += 1 + return iter([]) + mock_object = AwaitableMock() + client._client._transport._wrapped_methods[client._client._transport.delete_posix_account] = mock_object + + request = {} + await client.delete_posix_account(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_object.call_count == 1 + + await client.delete_posix_account(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_object.call_count == 2 + +@pytest.mark.asyncio +async def test_delete_posix_account_async(transport: str = 'grpc_asyncio', request_type=oslogin.DeletePosixAccountRequest): + client = OsLoginServiceAsyncClient( + 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_posix_account), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_posix_account(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = oslogin.DeletePosixAccountRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_posix_account_async_from_dict(): + await test_delete_posix_account_async(request_type=dict) + + +def test_delete_posix_account_field_headers(): + client = OsLoginServiceClient( + 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 = oslogin.DeletePosixAccountRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_posix_account), + '__call__') as call: + call.return_value = None + client.delete_posix_account(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', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_posix_account_field_headers_async(): + client = OsLoginServiceAsyncClient( + 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 = oslogin.DeletePosixAccountRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_posix_account), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_posix_account(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', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_posix_account_flattened(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_posix_account), + '__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_posix_account( + name='name_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].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_posix_account_flattened_error(): + client = OsLoginServiceClient( + 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_posix_account( + oslogin.DeletePosixAccountRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_posix_account_flattened_async(): + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_posix_account), + '__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_posix_account( + name='name_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].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_posix_account_flattened_error_async(): + client = OsLoginServiceAsyncClient( + 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_posix_account( + oslogin.DeletePosixAccountRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.DeleteSshPublicKeyRequest, + dict, +]) +def test_delete_ssh_public_key(request_type, transport: str = 'grpc'): + client = OsLoginServiceClient( + 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_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = None + response = client.delete_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = oslogin.DeleteSshPublicKeyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_ssh_public_key_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 = OsLoginServiceClient( + 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_ssh_public_key), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.delete_ssh_public_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.DeleteSshPublicKeyRequest() + + +def test_delete_ssh_public_key_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = oslogin.DeleteSshPublicKeyRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_ssh_public_key), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.delete_ssh_public_key(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.DeleteSshPublicKeyRequest( + name='name_value', + ) + +def test_delete_ssh_public_key_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.delete_ssh_public_key in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.delete_ssh_public_key] = mock_rpc + request = {} + client.delete_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_delete_ssh_public_key_empty_call_async(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_ssh_public_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.DeleteSshPublicKeyRequest() + +@pytest.mark.asyncio +async def test_delete_ssh_public_key_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.delete_ssh_public_key in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + class AwaitableMock(mock.AsyncMock): + def __await__(self): + self.await_count += 1 + return iter([]) + mock_object = AwaitableMock() + client._client._transport._wrapped_methods[client._client._transport.delete_ssh_public_key] = mock_object + + request = {} + await client.delete_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_object.call_count == 1 + + await client.delete_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_object.call_count == 2 + +@pytest.mark.asyncio +async def test_delete_ssh_public_key_async(transport: str = 'grpc_asyncio', request_type=oslogin.DeleteSshPublicKeyRequest): + client = OsLoginServiceAsyncClient( + 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_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + response = await client.delete_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = oslogin.DeleteSshPublicKeyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert response is None + + +@pytest.mark.asyncio +async def test_delete_ssh_public_key_async_from_dict(): + await test_delete_ssh_public_key_async(request_type=dict) + + +def test_delete_ssh_public_key_field_headers(): + client = OsLoginServiceClient( + 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 = oslogin.DeleteSshPublicKeyRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_ssh_public_key), + '__call__') as call: + call.return_value = None + client.delete_ssh_public_key(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', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_delete_ssh_public_key_field_headers_async(): + client = OsLoginServiceAsyncClient( + 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 = oslogin.DeleteSshPublicKeyRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_ssh_public_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) + await client.delete_ssh_public_key(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', + 'name=name_value', + ) in kw['metadata'] + + +def test_delete_ssh_public_key_flattened(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_ssh_public_key), + '__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_ssh_public_key( + name='name_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].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_delete_ssh_public_key_flattened_error(): + client = OsLoginServiceClient( + 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_ssh_public_key( + oslogin.DeleteSshPublicKeyRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_delete_ssh_public_key_flattened_async(): + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.delete_ssh_public_key), + '__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_ssh_public_key( + name='name_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].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_delete_ssh_public_key_flattened_error_async(): + client = OsLoginServiceAsyncClient( + 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_ssh_public_key( + oslogin.DeleteSshPublicKeyRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.GetLoginProfileRequest, + dict, +]) +def test_get_login_profile(request_type, transport: str = 'grpc'): + client = OsLoginServiceClient( + 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_login_profile), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = oslogin.LoginProfile( + name='name_value', + ) + response = client.get_login_profile(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = oslogin.GetLoginProfileRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, oslogin.LoginProfile) + assert response.name == 'name_value' + + +def test_get_login_profile_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 = OsLoginServiceClient( + 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_login_profile), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.get_login_profile() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.GetLoginProfileRequest() + + +def test_get_login_profile_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = oslogin.GetLoginProfileRequest( + name='name_value', + project_id='project_id_value', + system_id='system_id_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_login_profile), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.get_login_profile(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.GetLoginProfileRequest( + name='name_value', + project_id='project_id_value', + system_id='system_id_value', + ) + +def test_get_login_profile_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_login_profile in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_login_profile] = mock_rpc + request = {} + client.get_login_profile(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_login_profile(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_get_login_profile_empty_call_async(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_login_profile), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(oslogin.LoginProfile( + name='name_value', + )) + response = await client.get_login_profile() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.GetLoginProfileRequest() + +@pytest.mark.asyncio +async def test_get_login_profile_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.get_login_profile in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + class AwaitableMock(mock.AsyncMock): + def __await__(self): + self.await_count += 1 + return iter([]) + mock_object = AwaitableMock() + client._client._transport._wrapped_methods[client._client._transport.get_login_profile] = mock_object + + request = {} + await client.get_login_profile(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_object.call_count == 1 + + await client.get_login_profile(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_object.call_count == 2 + +@pytest.mark.asyncio +async def test_get_login_profile_async(transport: str = 'grpc_asyncio', request_type=oslogin.GetLoginProfileRequest): + client = OsLoginServiceAsyncClient( + 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_login_profile), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(oslogin.LoginProfile( + name='name_value', + )) + response = await client.get_login_profile(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = oslogin.GetLoginProfileRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, oslogin.LoginProfile) + assert response.name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_login_profile_async_from_dict(): + await test_get_login_profile_async(request_type=dict) + + +def test_get_login_profile_field_headers(): + client = OsLoginServiceClient( + 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 = oslogin.GetLoginProfileRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_login_profile), + '__call__') as call: + call.return_value = oslogin.LoginProfile() + client.get_login_profile(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', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_login_profile_field_headers_async(): + client = OsLoginServiceAsyncClient( + 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 = oslogin.GetLoginProfileRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_login_profile), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(oslogin.LoginProfile()) + await client.get_login_profile(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', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_login_profile_flattened(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_login_profile), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = oslogin.LoginProfile() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_login_profile( + name='name_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].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_login_profile_flattened_error(): + client = OsLoginServiceClient( + 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_login_profile( + oslogin.GetLoginProfileRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_login_profile_flattened_async(): + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_login_profile), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = oslogin.LoginProfile() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(oslogin.LoginProfile()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_login_profile( + name='name_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].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_login_profile_flattened_error_async(): + client = OsLoginServiceAsyncClient( + 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_login_profile( + oslogin.GetLoginProfileRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.GetSshPublicKeyRequest, + dict, +]) +def test_get_ssh_public_key(request_type, transport: str = 'grpc'): + client = OsLoginServiceClient( + 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_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = common.SshPublicKey( + key='key_value', + expiration_time_usec=2144, + fingerprint='fingerprint_value', + name='name_value', + ) + response = client.get_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = oslogin.GetSshPublicKeyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, common.SshPublicKey) + assert response.key == 'key_value' + assert response.expiration_time_usec == 2144 + assert response.fingerprint == 'fingerprint_value' + assert response.name == 'name_value' + + +def test_get_ssh_public_key_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 = OsLoginServiceClient( + 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_ssh_public_key), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.get_ssh_public_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.GetSshPublicKeyRequest() + + +def test_get_ssh_public_key_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = oslogin.GetSshPublicKeyRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_ssh_public_key), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.get_ssh_public_key(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.GetSshPublicKeyRequest( + name='name_value', + ) + +def test_get_ssh_public_key_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_ssh_public_key in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_ssh_public_key] = mock_rpc + request = {} + client.get_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_get_ssh_public_key_empty_call_async(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey( + key='key_value', + expiration_time_usec=2144, + fingerprint='fingerprint_value', + name='name_value', + )) + response = await client.get_ssh_public_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.GetSshPublicKeyRequest() + +@pytest.mark.asyncio +async def test_get_ssh_public_key_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.get_ssh_public_key in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + class AwaitableMock(mock.AsyncMock): + def __await__(self): + self.await_count += 1 + return iter([]) + mock_object = AwaitableMock() + client._client._transport._wrapped_methods[client._client._transport.get_ssh_public_key] = mock_object + + request = {} + await client.get_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_object.call_count == 1 + + await client.get_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_object.call_count == 2 + +@pytest.mark.asyncio +async def test_get_ssh_public_key_async(transport: str = 'grpc_asyncio', request_type=oslogin.GetSshPublicKeyRequest): + client = OsLoginServiceAsyncClient( + 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_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey( + key='key_value', + expiration_time_usec=2144, + fingerprint='fingerprint_value', + name='name_value', + )) + response = await client.get_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = oslogin.GetSshPublicKeyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, common.SshPublicKey) + assert response.key == 'key_value' + assert response.expiration_time_usec == 2144 + assert response.fingerprint == 'fingerprint_value' + assert response.name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_ssh_public_key_async_from_dict(): + await test_get_ssh_public_key_async(request_type=dict) + + +def test_get_ssh_public_key_field_headers(): + client = OsLoginServiceClient( + 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 = oslogin.GetSshPublicKeyRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_ssh_public_key), + '__call__') as call: + call.return_value = common.SshPublicKey() + client.get_ssh_public_key(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', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_get_ssh_public_key_field_headers_async(): + client = OsLoginServiceAsyncClient( + 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 = oslogin.GetSshPublicKeyRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_ssh_public_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey()) + await client.get_ssh_public_key(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', + 'name=name_value', + ) in kw['metadata'] + + +def test_get_ssh_public_key_flattened(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = common.SshPublicKey() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.get_ssh_public_key( + name='name_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].name + mock_val = 'name_value' + assert arg == mock_val + + +def test_get_ssh_public_key_flattened_error(): + client = OsLoginServiceClient( + 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_ssh_public_key( + oslogin.GetSshPublicKeyRequest(), + name='name_value', + ) + +@pytest.mark.asyncio +async def test_get_ssh_public_key_flattened_async(): + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.get_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = common.SshPublicKey() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.get_ssh_public_key( + name='name_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].name + mock_val = 'name_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_get_ssh_public_key_flattened_error_async(): + client = OsLoginServiceAsyncClient( + 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_ssh_public_key( + oslogin.GetSshPublicKeyRequest(), + name='name_value', + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.ImportSshPublicKeyRequest, + dict, +]) +def test_import_ssh_public_key(request_type, transport: str = 'grpc'): + client = OsLoginServiceClient( + 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.import_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = oslogin.ImportSshPublicKeyResponse( + details='details_value', + ) + response = client.import_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = oslogin.ImportSshPublicKeyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, oslogin.ImportSshPublicKeyResponse) + assert response.details == 'details_value' + + +def test_import_ssh_public_key_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 = OsLoginServiceClient( + 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.import_ssh_public_key), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.import_ssh_public_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.ImportSshPublicKeyRequest() + + +def test_import_ssh_public_key_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = oslogin.ImportSshPublicKeyRequest( + parent='parent_value', + project_id='project_id_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.import_ssh_public_key), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.import_ssh_public_key(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.ImportSshPublicKeyRequest( + parent='parent_value', + project_id='project_id_value', + ) + +def test_import_ssh_public_key_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.import_ssh_public_key in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.import_ssh_public_key] = mock_rpc + request = {} + client.import_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.import_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_import_ssh_public_key_empty_call_async(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.import_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(oslogin.ImportSshPublicKeyResponse( + details='details_value', + )) + response = await client.import_ssh_public_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.ImportSshPublicKeyRequest() + +@pytest.mark.asyncio +async def test_import_ssh_public_key_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.import_ssh_public_key in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + class AwaitableMock(mock.AsyncMock): + def __await__(self): + self.await_count += 1 + return iter([]) + mock_object = AwaitableMock() + client._client._transport._wrapped_methods[client._client._transport.import_ssh_public_key] = mock_object + + request = {} + await client.import_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_object.call_count == 1 + + await client.import_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_object.call_count == 2 + +@pytest.mark.asyncio +async def test_import_ssh_public_key_async(transport: str = 'grpc_asyncio', request_type=oslogin.ImportSshPublicKeyRequest): + client = OsLoginServiceAsyncClient( + 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.import_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(oslogin.ImportSshPublicKeyResponse( + details='details_value', + )) + response = await client.import_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = oslogin.ImportSshPublicKeyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, oslogin.ImportSshPublicKeyResponse) + assert response.details == 'details_value' + + +@pytest.mark.asyncio +async def test_import_ssh_public_key_async_from_dict(): + await test_import_ssh_public_key_async(request_type=dict) + + +def test_import_ssh_public_key_field_headers(): + client = OsLoginServiceClient( + 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 = oslogin.ImportSshPublicKeyRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.import_ssh_public_key), + '__call__') as call: + call.return_value = oslogin.ImportSshPublicKeyResponse() + client.import_ssh_public_key(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', + 'parent=parent_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_import_ssh_public_key_field_headers_async(): + client = OsLoginServiceAsyncClient( + 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 = oslogin.ImportSshPublicKeyRequest() + + request.parent = 'parent_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.import_ssh_public_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(oslogin.ImportSshPublicKeyResponse()) + await client.import_ssh_public_key(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', + 'parent=parent_value', + ) in kw['metadata'] + + +def test_import_ssh_public_key_flattened(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.import_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = oslogin.ImportSshPublicKeyResponse() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.import_ssh_public_key( + parent='parent_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + project_id='project_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].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].ssh_public_key + mock_val = common.SshPublicKey(key='key_value') + assert arg == mock_val + arg = args[0].project_id + mock_val = 'project_id_value' + assert arg == mock_val + + +def test_import_ssh_public_key_flattened_error(): + client = OsLoginServiceClient( + 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.import_ssh_public_key( + oslogin.ImportSshPublicKeyRequest(), + parent='parent_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + project_id='project_id_value', + ) + +@pytest.mark.asyncio +async def test_import_ssh_public_key_flattened_async(): + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.import_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = oslogin.ImportSshPublicKeyResponse() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(oslogin.ImportSshPublicKeyResponse()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.import_ssh_public_key( + parent='parent_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + project_id='project_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].parent + mock_val = 'parent_value' + assert arg == mock_val + arg = args[0].ssh_public_key + mock_val = common.SshPublicKey(key='key_value') + assert arg == mock_val + arg = args[0].project_id + mock_val = 'project_id_value' + assert arg == mock_val + +@pytest.mark.asyncio +async def test_import_ssh_public_key_flattened_error_async(): + client = OsLoginServiceAsyncClient( + 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.import_ssh_public_key( + oslogin.ImportSshPublicKeyRequest(), + parent='parent_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + project_id='project_id_value', + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.UpdateSshPublicKeyRequest, + dict, +]) +def test_update_ssh_public_key(request_type, transport: str = 'grpc'): + client = OsLoginServiceClient( + 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_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = common.SshPublicKey( + key='key_value', + expiration_time_usec=2144, + fingerprint='fingerprint_value', + name='name_value', + ) + response = client.update_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) == 1 + _, args, _ = call.mock_calls[0] + request = oslogin.UpdateSshPublicKeyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, common.SshPublicKey) + assert response.key == 'key_value' + assert response.expiration_time_usec == 2144 + assert response.fingerprint == 'fingerprint_value' + assert response.name == 'name_value' + + +def test_update_ssh_public_key_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 = OsLoginServiceClient( + 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_ssh_public_key), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.update_ssh_public_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.UpdateSshPublicKeyRequest() + + +def test_update_ssh_public_key_non_empty_request_with_auto_populated_field(): + # This test is a coverage failsafe to make sure that UUID4 fields are + # automatically populated, according to AIP-4235, with non-empty requests. + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc', + ) + + # Populate all string fields in the request which are not UUID4 + # since we want to check that UUID4 are populated automatically + # if they meet the requirements of AIP 4235. + request = oslogin.UpdateSshPublicKeyRequest( + name='name_value', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_ssh_public_key), + '__call__') as call: + call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client.update_ssh_public_key(request=request) + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.UpdateSshPublicKeyRequest( + name='name_value', + ) + +def test_update_ssh_public_key_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="grpc", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.update_ssh_public_key in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.update_ssh_public_key] = mock_rpc + request = {} + client.update_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + +@pytest.mark.asyncio +async def test_update_ssh_public_key_empty_call_async(): + # This test is a coverage failsafe to make sure that totally empty calls, + # i.e. request == None and no flattened fields passed, work. + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='grpc_asyncio', + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey( + key='key_value', + expiration_time_usec=2144, + fingerprint='fingerprint_value', + name='name_value', + )) + response = await client.update_ssh_public_key() + call.assert_called() + _, args, _ = call.mock_calls[0] + assert args[0] == oslogin.UpdateSshPublicKeyRequest() + +@pytest.mark.asyncio +async def test_update_ssh_public_key_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._client._transport.update_ssh_public_key in client._client._transport._wrapped_methods + + # Replace cached wrapped function with mock + class AwaitableMock(mock.AsyncMock): + def __await__(self): + self.await_count += 1 + return iter([]) + mock_object = AwaitableMock() + client._client._transport._wrapped_methods[client._client._transport.update_ssh_public_key] = mock_object + + request = {} + await client.update_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_object.call_count == 1 + + await client.update_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_object.call_count == 2 + +@pytest.mark.asyncio +async def test_update_ssh_public_key_async(transport: str = 'grpc_asyncio', request_type=oslogin.UpdateSshPublicKeyRequest): + client = OsLoginServiceAsyncClient( + 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_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey( + key='key_value', + expiration_time_usec=2144, + fingerprint='fingerprint_value', + name='name_value', + )) + response = await client.update_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert len(call.mock_calls) + _, args, _ = call.mock_calls[0] + request = oslogin.UpdateSshPublicKeyRequest() + assert args[0] == request + + # Establish that the response is the type that we expect. + assert isinstance(response, common.SshPublicKey) + assert response.key == 'key_value' + assert response.expiration_time_usec == 2144 + assert response.fingerprint == 'fingerprint_value' + assert response.name == 'name_value' + + +@pytest.mark.asyncio +async def test_update_ssh_public_key_async_from_dict(): + await test_update_ssh_public_key_async(request_type=dict) + + +def test_update_ssh_public_key_field_headers(): + client = OsLoginServiceClient( + 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 = oslogin.UpdateSshPublicKeyRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_ssh_public_key), + '__call__') as call: + call.return_value = common.SshPublicKey() + client.update_ssh_public_key(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', + 'name=name_value', + ) in kw['metadata'] + + +@pytest.mark.asyncio +async def test_update_ssh_public_key_field_headers_async(): + client = OsLoginServiceAsyncClient( + 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 = oslogin.UpdateSshPublicKeyRequest() + + request.name = 'name_value' + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_ssh_public_key), + '__call__') as call: + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey()) + await client.update_ssh_public_key(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', + 'name=name_value', + ) in kw['metadata'] + + +def test_update_ssh_public_key_flattened(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = common.SshPublicKey() + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + client.update_ssh_public_key( + name='name_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_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].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].ssh_public_key + mock_val = common.SshPublicKey(key='key_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + + +def test_update_ssh_public_key_flattened_error(): + client = OsLoginServiceClient( + 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_ssh_public_key( + oslogin.UpdateSshPublicKeyRequest(), + name='name_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + +@pytest.mark.asyncio +async def test_update_ssh_public_key_flattened_async(): + client = OsLoginServiceAsyncClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Mock the actual call within the gRPC stub, and fake the request. + with mock.patch.object( + type(client.transport.update_ssh_public_key), + '__call__') as call: + # Designate an appropriate return value for the call. + call.return_value = common.SshPublicKey() + + call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey()) + # Call the method with a truthy value for each flattened field, + # using the keyword arguments to the method. + response = await client.update_ssh_public_key( + name='name_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_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].name + mock_val = 'name_value' + assert arg == mock_val + arg = args[0].ssh_public_key + mock_val = common.SshPublicKey(key='key_value') + assert arg == mock_val + arg = args[0].update_mask + mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) + assert arg == mock_val + +@pytest.mark.asyncio +async def test_update_ssh_public_key_flattened_error_async(): + client = OsLoginServiceAsyncClient( + 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_ssh_public_key( + oslogin.UpdateSshPublicKeyRequest(), + name='name_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.CreateSshPublicKeyRequest, + dict, +]) +def test_create_ssh_public_key_rest(request_type): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'users/sample1'} + request_init["ssh_public_key"] = {'key': 'key_value', 'expiration_time_usec': 2144, 'fingerprint': 'fingerprint_value', 'name': 'name_value'} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = oslogin.CreateSshPublicKeyRequest.meta.fields["ssh_public_key"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["ssh_public_key"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["ssh_public_key"][field])): + del request_init["ssh_public_key"][field][i][subfield] + else: + del request_init["ssh_public_key"][field][subfield] + 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 = common.SshPublicKey( + key='key_value', + expiration_time_usec=2144, + fingerprint='fingerprint_value', + name='name_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = common.SshPublicKey.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.create_ssh_public_key(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, common.SshPublicKey) + assert response.key == 'key_value' + assert response.expiration_time_usec == 2144 + assert response.fingerprint == 'fingerprint_value' + assert response.name == 'name_value' + +def test_create_ssh_public_key_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.create_ssh_public_key in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.create_ssh_public_key] = mock_rpc + + request = {} + client.create_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.create_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_create_ssh_public_key_rest_required_fields(request_type=oslogin.CreateSshPublicKeyRequest): + transport_class = transports.OsLoginServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_ssh_public_key._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_ssh_public_key._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = common.SshPublicKey() + # 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 + + # Convert return value to protobuf type + return_value = common.SshPublicKey.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.create_ssh_public_key(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_create_ssh_public_key_rest_unset_required_fields(): + transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.create_ssh_public_key._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("parent", "sshPublicKey", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_create_ssh_public_key_rest_interceptors(null_interceptor): + transport = transports.OsLoginServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), + ) + client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "post_create_ssh_public_key") as post, \ + mock.patch.object(transports.OsLoginServiceRestInterceptor, "pre_create_ssh_public_key") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = oslogin.CreateSshPublicKeyRequest.pb(oslogin.CreateSshPublicKeyRequest()) + 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 = common.SshPublicKey.to_json(common.SshPublicKey()) + + request = oslogin.CreateSshPublicKeyRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = common.SshPublicKey() + + client.create_ssh_public_key(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_create_ssh_public_key_rest_bad_request(transport: str = 'rest', request_type=oslogin.CreateSshPublicKeyRequest): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'users/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.create_ssh_public_key(request) + + +def test_create_ssh_public_key_rest_flattened(): + client = OsLoginServiceClient( + 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 = common.SshPublicKey() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'users/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = common.SshPublicKey.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.create_ssh_public_key(**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/v1/{parent=users/*}/sshPublicKeys" % client.transport._host, args[1]) + + +def test_create_ssh_public_key_rest_flattened_error(transport: str = 'rest'): + client = OsLoginServiceClient( + 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.create_ssh_public_key( + oslogin.CreateSshPublicKeyRequest(), + parent='parent_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + ) + + +def test_create_ssh_public_key_rest_error(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.DeletePosixAccountRequest, + dict, +]) +def test_delete_posix_account_rest(request_type): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'users/sample1/projects/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_posix_account(request) + + # Establish that the response is the type that we expect. + assert response is None + +def test_delete_posix_account_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.delete_posix_account in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.delete_posix_account] = mock_rpc + + request = {} + client.delete_posix_account(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_posix_account(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_delete_posix_account_rest_required_fields(request_type=oslogin.DeletePosixAccountRequest): + transport_class = transports.OsLoginServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_posix_account._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_posix_account._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = OsLoginServiceClient( + 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_posix_account(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_posix_account_rest_unset_required_fields(): + transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_posix_account._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_posix_account_rest_interceptors(null_interceptor): + transport = transports.OsLoginServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), + ) + client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "pre_delete_posix_account") as pre: + pre.assert_not_called() + pb_message = oslogin.DeletePosixAccountRequest.pb(oslogin.DeletePosixAccountRequest()) + 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 = oslogin.DeletePosixAccountRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_posix_account(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_delete_posix_account_rest_bad_request(transport: str = 'rest', request_type=oslogin.DeletePosixAccountRequest): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'users/sample1/projects/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_posix_account(request) + + +def test_delete_posix_account_rest_flattened(): + client = OsLoginServiceClient( + 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 = {'name': 'users/sample1/projects/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_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_posix_account(**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/v1/{name=users/*/projects/*}" % client.transport._host, args[1]) + + +def test_delete_posix_account_rest_flattened_error(transport: str = 'rest'): + client = OsLoginServiceClient( + 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_posix_account( + oslogin.DeletePosixAccountRequest(), + name='name_value', + ) + + +def test_delete_posix_account_rest_error(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.DeleteSshPublicKeyRequest, + dict, +]) +def test_delete_ssh_public_key_rest(request_type): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'users/sample1/sshPublicKeys/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_ssh_public_key(request) + + # Establish that the response is the type that we expect. + assert response is None + +def test_delete_ssh_public_key_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.delete_ssh_public_key in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.delete_ssh_public_key] = mock_rpc + + request = {} + client.delete_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.delete_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_delete_ssh_public_key_rest_required_fields(request_type=oslogin.DeleteSshPublicKeyRequest): + transport_class = transports.OsLoginServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_ssh_public_key._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_ssh_public_key._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = OsLoginServiceClient( + 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_ssh_public_key(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_delete_ssh_public_key_rest_unset_required_fields(): + transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.delete_ssh_public_key._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_delete_ssh_public_key_rest_interceptors(null_interceptor): + transport = transports.OsLoginServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), + ) + client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "pre_delete_ssh_public_key") as pre: + pre.assert_not_called() + pb_message = oslogin.DeleteSshPublicKeyRequest.pb(oslogin.DeleteSshPublicKeyRequest()) + 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 = oslogin.DeleteSshPublicKeyRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + + client.delete_ssh_public_key(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + + +def test_delete_ssh_public_key_rest_bad_request(transport: str = 'rest', request_type=oslogin.DeleteSshPublicKeyRequest): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'users/sample1/sshPublicKeys/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_ssh_public_key(request) + + +def test_delete_ssh_public_key_rest_flattened(): + client = OsLoginServiceClient( + 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 = {'name': 'users/sample1/sshPublicKeys/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_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_ssh_public_key(**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/v1/{name=users/*/sshPublicKeys/*}" % client.transport._host, args[1]) + + +def test_delete_ssh_public_key_rest_flattened_error(transport: str = 'rest'): + client = OsLoginServiceClient( + 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_ssh_public_key( + oslogin.DeleteSshPublicKeyRequest(), + name='name_value', + ) + + +def test_delete_ssh_public_key_rest_error(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.GetLoginProfileRequest, + dict, +]) +def test_get_login_profile_rest(request_type): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'users/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 = oslogin.LoginProfile( + name='name_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = oslogin.LoginProfile.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_login_profile(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, oslogin.LoginProfile) + assert response.name == 'name_value' + +def test_get_login_profile_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_login_profile in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_login_profile] = mock_rpc + + request = {} + client.get_login_profile(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_login_profile(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_login_profile_rest_required_fields(request_type=oslogin.GetLoginProfileRequest): + transport_class = transports.OsLoginServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_login_profile._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_login_profile._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("project_id", "system_id", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = oslogin.LoginProfile() + # 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 + + # Convert return value to protobuf type + return_value = oslogin.LoginProfile.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_login_profile(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_login_profile_rest_unset_required_fields(): + transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_login_profile._get_unset_required_fields({}) + assert set(unset_fields) == (set(("projectId", "systemId", )) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_login_profile_rest_interceptors(null_interceptor): + transport = transports.OsLoginServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), + ) + client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "post_get_login_profile") as post, \ + mock.patch.object(transports.OsLoginServiceRestInterceptor, "pre_get_login_profile") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = oslogin.GetLoginProfileRequest.pb(oslogin.GetLoginProfileRequest()) + 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 = oslogin.LoginProfile.to_json(oslogin.LoginProfile()) + + request = oslogin.GetLoginProfileRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = oslogin.LoginProfile() + + client.get_login_profile(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_login_profile_rest_bad_request(transport: str = 'rest', request_type=oslogin.GetLoginProfileRequest): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'users/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.get_login_profile(request) + + +def test_get_login_profile_rest_flattened(): + client = OsLoginServiceClient( + 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 = oslogin.LoginProfile() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'users/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = oslogin.LoginProfile.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_login_profile(**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/v1/{name=users/*}/loginProfile" % client.transport._host, args[1]) + + +def test_get_login_profile_rest_flattened_error(transport: str = 'rest'): + client = OsLoginServiceClient( + 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_login_profile( + oslogin.GetLoginProfileRequest(), + name='name_value', + ) + + +def test_get_login_profile_rest_error(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.GetSshPublicKeyRequest, + dict, +]) +def test_get_ssh_public_key_rest(request_type): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'users/sample1/sshPublicKeys/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 = common.SshPublicKey( + key='key_value', + expiration_time_usec=2144, + fingerprint='fingerprint_value', + name='name_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = common.SshPublicKey.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.get_ssh_public_key(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, common.SshPublicKey) + assert response.key == 'key_value' + assert response.expiration_time_usec == 2144 + assert response.fingerprint == 'fingerprint_value' + assert response.name == 'name_value' + +def test_get_ssh_public_key_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.get_ssh_public_key in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.get_ssh_public_key] = mock_rpc + + request = {} + client.get_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.get_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_get_ssh_public_key_rest_required_fields(request_type=oslogin.GetSshPublicKeyRequest): + transport_class = transports.OsLoginServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_ssh_public_key._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_ssh_public_key._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = common.SshPublicKey() + # 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 + + # Convert return value to protobuf type + return_value = common.SshPublicKey.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.get_ssh_public_key(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_get_ssh_public_key_rest_unset_required_fields(): + transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.get_ssh_public_key._get_unset_required_fields({}) + assert set(unset_fields) == (set(()) & set(("name", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_get_ssh_public_key_rest_interceptors(null_interceptor): + transport = transports.OsLoginServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), + ) + client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "post_get_ssh_public_key") as post, \ + mock.patch.object(transports.OsLoginServiceRestInterceptor, "pre_get_ssh_public_key") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = oslogin.GetSshPublicKeyRequest.pb(oslogin.GetSshPublicKeyRequest()) + 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 = common.SshPublicKey.to_json(common.SshPublicKey()) + + request = oslogin.GetSshPublicKeyRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = common.SshPublicKey() + + client.get_ssh_public_key(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_get_ssh_public_key_rest_bad_request(transport: str = 'rest', request_type=oslogin.GetSshPublicKeyRequest): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'users/sample1/sshPublicKeys/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_ssh_public_key(request) + + +def test_get_ssh_public_key_rest_flattened(): + client = OsLoginServiceClient( + 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 = common.SshPublicKey() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'users/sample1/sshPublicKeys/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = common.SshPublicKey.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.get_ssh_public_key(**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/v1/{name=users/*/sshPublicKeys/*}" % client.transport._host, args[1]) + + +def test_get_ssh_public_key_rest_flattened_error(transport: str = 'rest'): + client = OsLoginServiceClient( + 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_ssh_public_key( + oslogin.GetSshPublicKeyRequest(), + name='name_value', + ) + + +def test_get_ssh_public_key_rest_error(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.ImportSshPublicKeyRequest, + dict, +]) +def test_import_ssh_public_key_rest(request_type): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'users/sample1'} + request_init["ssh_public_key"] = {'key': 'key_value', 'expiration_time_usec': 2144, 'fingerprint': 'fingerprint_value', 'name': 'name_value'} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = oslogin.ImportSshPublicKeyRequest.meta.fields["ssh_public_key"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["ssh_public_key"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["ssh_public_key"][field])): + del request_init["ssh_public_key"][field][i][subfield] + else: + del request_init["ssh_public_key"][field][subfield] + 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 = oslogin.ImportSshPublicKeyResponse( + details='details_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = oslogin.ImportSshPublicKeyResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.import_ssh_public_key(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, oslogin.ImportSshPublicKeyResponse) + assert response.details == 'details_value' + +def test_import_ssh_public_key_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.import_ssh_public_key in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.import_ssh_public_key] = mock_rpc + + request = {} + client.import_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.import_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_import_ssh_public_key_rest_required_fields(request_type=oslogin.ImportSshPublicKeyRequest): + transport_class = transports.OsLoginServiceRestTransport + + request_init = {} + request_init["parent"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).import_ssh_public_key._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["parent"] = 'parent_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).import_ssh_public_key._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("project_id", "regions", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "parent" in jsonified_request + assert jsonified_request["parent"] == 'parent_value' + + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = oslogin.ImportSshPublicKeyResponse() + # 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 + + # Convert return value to protobuf type + return_value = oslogin.ImportSshPublicKeyResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.import_ssh_public_key(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_import_ssh_public_key_rest_unset_required_fields(): + transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.import_ssh_public_key._get_unset_required_fields({}) + assert set(unset_fields) == (set(("projectId", "regions", )) & set(("parent", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_import_ssh_public_key_rest_interceptors(null_interceptor): + transport = transports.OsLoginServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), + ) + client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "post_import_ssh_public_key") as post, \ + mock.patch.object(transports.OsLoginServiceRestInterceptor, "pre_import_ssh_public_key") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = oslogin.ImportSshPublicKeyRequest.pb(oslogin.ImportSshPublicKeyRequest()) + 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 = oslogin.ImportSshPublicKeyResponse.to_json(oslogin.ImportSshPublicKeyResponse()) + + request = oslogin.ImportSshPublicKeyRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = oslogin.ImportSshPublicKeyResponse() + + client.import_ssh_public_key(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_import_ssh_public_key_rest_bad_request(transport: str = 'rest', request_type=oslogin.ImportSshPublicKeyRequest): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'parent': 'users/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.import_ssh_public_key(request) + + +def test_import_ssh_public_key_rest_flattened(): + client = OsLoginServiceClient( + 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 = oslogin.ImportSshPublicKeyResponse() + + # get arguments that satisfy an http rule for this method + sample_request = {'parent': 'users/sample1'} + + # get truthy value for each flattened field + mock_args = dict( + parent='parent_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + project_id='project_id_value', + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = oslogin.ImportSshPublicKeyResponse.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.import_ssh_public_key(**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/v1/{parent=users/*}:importSshPublicKey" % client.transport._host, args[1]) + + +def test_import_ssh_public_key_rest_flattened_error(transport: str = 'rest'): + client = OsLoginServiceClient( + 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.import_ssh_public_key( + oslogin.ImportSshPublicKeyRequest(), + parent='parent_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + project_id='project_id_value', + ) + + +def test_import_ssh_public_key_rest_error(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +@pytest.mark.parametrize("request_type", [ + oslogin.UpdateSshPublicKeyRequest, + dict, +]) +def test_update_ssh_public_key_rest(request_type): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'users/sample1/sshPublicKeys/sample2'} + request_init["ssh_public_key"] = {'key': 'key_value', 'expiration_time_usec': 2144, 'fingerprint': 'fingerprint_value', 'name': 'name_value'} + # The version of a generated dependency at test runtime may differ from the version used during generation. + # Delete any fields which are not present in the current runtime dependency + # See https://github.com/googleapis/gapic-generator-python/issues/1748 + + # Determine if the message type is proto-plus or protobuf + test_field = oslogin.UpdateSshPublicKeyRequest.meta.fields["ssh_public_key"] + + def get_message_fields(field): + # Given a field which is a message (composite type), return a list with + # all the fields of the message. + # If the field is not a composite type, return an empty list. + message_fields = [] + + if hasattr(field, "message") and field.message: + is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") + + if is_field_type_proto_plus_type: + message_fields = field.message.meta.fields.values() + # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types + else: # pragma: NO COVER + message_fields = field.message.DESCRIPTOR.fields + return message_fields + + runtime_nested_fields = [ + (field.name, nested_field.name) + for field in get_message_fields(test_field) + for nested_field in get_message_fields(field) + ] + + subfields_not_in_runtime = [] + + # For each item in the sample request, create a list of sub fields which are not present at runtime + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for field, value in request_init["ssh_public_key"].items(): # pragma: NO COVER + result = None + is_repeated = False + # For repeated fields + if isinstance(value, list) and len(value): + is_repeated = True + result = value[0] + # For fields where the type is another message + if isinstance(value, dict): + result = value + + if result and hasattr(result, "keys"): + for subfield in result.keys(): + if (field, subfield) not in runtime_nested_fields: + subfields_not_in_runtime.append( + {"field": field, "subfield": subfield, "is_repeated": is_repeated} + ) + + # Remove fields from the sample request which are not present in the runtime version of the dependency + # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime + for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER + field = subfield_to_delete.get("field") + field_repeated = subfield_to_delete.get("is_repeated") + subfield = subfield_to_delete.get("subfield") + if subfield: + if field_repeated: + for i in range(0, len(request_init["ssh_public_key"][field])): + del request_init["ssh_public_key"][field][i][subfield] + else: + del request_init["ssh_public_key"][field][subfield] + 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 = common.SshPublicKey( + key='key_value', + expiration_time_usec=2144, + fingerprint='fingerprint_value', + name='name_value', + ) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = common.SshPublicKey.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + response = client.update_ssh_public_key(request) + + # Establish that the response is the type that we expect. + assert isinstance(response, common.SshPublicKey) + assert response.key == 'key_value' + assert response.expiration_time_usec == 2144 + assert response.fingerprint == 'fingerprint_value' + assert response.name == 'name_value' + +def test_update_ssh_public_key_rest_use_cached_wrapped_rpc(): + # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, + # instead of constructing them on each call + with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport="rest", + ) + + # Should wrap all calls on client creation + assert wrapper_fn.call_count > 0 + wrapper_fn.reset_mock() + + # Ensure method has been cached + assert client._transport.update_ssh_public_key in client._transport._wrapped_methods + + # Replace cached wrapped function with mock + mock_rpc = mock.Mock() + mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. + client._transport._wrapped_methods[client._transport.update_ssh_public_key] = mock_rpc + + request = {} + client.update_ssh_public_key(request) + + # Establish that the underlying gRPC stub method was called. + assert mock_rpc.call_count == 1 + + client.update_ssh_public_key(request) + + # Establish that a new wrapper was not created for this call + assert wrapper_fn.call_count == 0 + assert mock_rpc.call_count == 2 + + +def test_update_ssh_public_key_rest_required_fields(request_type=oslogin.UpdateSshPublicKeyRequest): + transport_class = transports.OsLoginServiceRestTransport + + request_init = {} + request_init["name"] = "" + request = request_type(**request_init) + pb_request = request_type.pb(request) + jsonified_request = json.loads(json_format.MessageToJson( + pb_request, + use_integers_for_enums=False + )) + + # verify fields with default values are dropped + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_ssh_public_key._get_unset_required_fields(jsonified_request) + jsonified_request.update(unset_fields) + + # verify required fields with default values are now present + + jsonified_request["name"] = 'name_value' + + unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_ssh_public_key._get_unset_required_fields(jsonified_request) + # Check that path parameters and body parameters are not mixing in. + assert not set(unset_fields) - set(("update_mask", )) + jsonified_request.update(unset_fields) + + # verify required fields with non-default values are left alone + assert "name" in jsonified_request + assert jsonified_request["name"] == 'name_value' + + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest', + ) + request = request_type(**request_init) + + # Designate an appropriate value for the returned response. + return_value = common.SshPublicKey() + # 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': "patch", + 'query_params': pb_request, + } + transcode_result['body'] = pb_request + transcode.return_value = transcode_result + + response_value = Response() + response_value.status_code = 200 + + # Convert return value to protobuf type + return_value = common.SshPublicKey.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + response = client.update_ssh_public_key(request) + + expected_params = [ + ('$alt', 'json;enum-encoding=int') + ] + actual_params = req.call_args.kwargs['params'] + assert expected_params == actual_params + + +def test_update_ssh_public_key_rest_unset_required_fields(): + transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) + + unset_fields = transport.update_ssh_public_key._get_unset_required_fields({}) + assert set(unset_fields) == (set(("updateMask", )) & set(("name", "sshPublicKey", ))) + + +@pytest.mark.parametrize("null_interceptor", [True, False]) +def test_update_ssh_public_key_rest_interceptors(null_interceptor): + transport = transports.OsLoginServiceRestTransport( + credentials=ga_credentials.AnonymousCredentials(), + interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), + ) + client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "post_update_ssh_public_key") as post, \ + mock.patch.object(transports.OsLoginServiceRestInterceptor, "pre_update_ssh_public_key") as pre: + pre.assert_not_called() + post.assert_not_called() + pb_message = oslogin.UpdateSshPublicKeyRequest.pb(oslogin.UpdateSshPublicKeyRequest()) + 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 = common.SshPublicKey.to_json(common.SshPublicKey()) + + request = oslogin.UpdateSshPublicKeyRequest() + metadata =[ + ("key", "val"), + ("cephalopod", "squid"), + ] + pre.return_value = request, metadata + post.return_value = common.SshPublicKey() + + client.update_ssh_public_key(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) + + pre.assert_called_once() + post.assert_called_once() + + +def test_update_ssh_public_key_rest_bad_request(transport: str = 'rest', request_type=oslogin.UpdateSshPublicKeyRequest): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # send a request that will satisfy transcoding + request_init = {'name': 'users/sample1/sshPublicKeys/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_ssh_public_key(request) + + +def test_update_ssh_public_key_rest_flattened(): + client = OsLoginServiceClient( + 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 = common.SshPublicKey() + + # get arguments that satisfy an http rule for this method + sample_request = {'name': 'users/sample1/sshPublicKeys/sample2'} + + # get truthy value for each flattened field + mock_args = dict( + name='name_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + mock_args.update(sample_request) + + # Wrap the value into a proper Response obj + response_value = Response() + response_value.status_code = 200 + # Convert return value to protobuf type + return_value = common.SshPublicKey.pb(return_value) + json_return_value = json_format.MessageToJson(return_value) + response_value._content = json_return_value.encode('UTF-8') + req.return_value = response_value + + client.update_ssh_public_key(**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/v1/{name=users/*/sshPublicKeys/*}" % client.transport._host, args[1]) + + +def test_update_ssh_public_key_rest_flattened_error(transport: str = 'rest'): + client = OsLoginServiceClient( + 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_ssh_public_key( + oslogin.UpdateSshPublicKeyRequest(), + name='name_value', + ssh_public_key=common.SshPublicKey(key='key_value'), + update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), + ) + + +def test_update_ssh_public_key_rest_error(): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport='rest' + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.OsLoginServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.OsLoginServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OsLoginServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide an api_key and a transport instance. + transport = transports.OsLoginServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = OsLoginServiceClient( + client_options=options, + transport=transport, + ) + + # It is an error to provide an api_key and a credential. + options = client_options.ClientOptions() + options.api_key = "api_key" + with pytest.raises(ValueError): + client = OsLoginServiceClient( + client_options=options, + credentials=ga_credentials.AnonymousCredentials() + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.OsLoginServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OsLoginServiceClient( + client_options={"scopes": ["1", "2"]}, + transport=transport, + ) + + +def test_transport_instance(): + # A client may be instantiated with a custom transport instance. + transport = transports.OsLoginServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + client = OsLoginServiceClient(transport=transport) + assert client.transport is transport + +def test_transport_get_channel(): + # A client may be instantiated with a custom transport instance. + transport = transports.OsLoginServiceGrpcTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.OsLoginServiceGrpcAsyncIOTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + +@pytest.mark.parametrize("transport_class", [ + transports.OsLoginServiceGrpcTransport, + transports.OsLoginServiceGrpcAsyncIOTransport, + transports.OsLoginServiceRestTransport, +]) +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 = OsLoginServiceClient.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 = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + ) + assert isinstance( + client.transport, + transports.OsLoginServiceGrpcTransport, + ) + +def test_os_login_service_base_transport_error(): + # Passing both a credentials object and credentials_file should raise an error + with pytest.raises(core_exceptions.DuplicateCredentialArgs): + transport = transports.OsLoginServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + credentials_file="credentials.json" + ) + + +def test_os_login_service_base_transport(): + # Instantiate the base transport. + with mock.patch('google.cloud.oslogin_v1.services.os_login_service.transports.OsLoginServiceTransport.__init__') as Transport: + Transport.return_value = None + transport = transports.OsLoginServiceTransport( + credentials=ga_credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + 'create_ssh_public_key', + 'delete_posix_account', + 'delete_ssh_public_key', + 'get_login_profile', + 'get_ssh_public_key', + 'import_ssh_public_key', + 'update_ssh_public_key', + ) + 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_os_login_service_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.oslogin_v1.services.os_login_service.transports.OsLoginServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.OsLoginServiceTransport( + 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-platform.read-only', + 'https://www.googleapis.com/auth/compute', + 'https://www.googleapis.com/auth/compute.readonly', +), + quota_project_id="octopus", + ) + + +def test_os_login_service_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.oslogin_v1.services.os_login_service.transports.OsLoginServiceTransport._prep_wrapped_messages') as Transport: + Transport.return_value = None + adc.return_value = (ga_credentials.AnonymousCredentials(), None) + transport = transports.OsLoginServiceTransport() + adc.assert_called_once() + + +def test_os_login_service_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) + OsLoginServiceClient() + adc.assert_called_once_with( + scopes=None, + default_scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/cloud-platform.read-only', + 'https://www.googleapis.com/auth/compute', + 'https://www.googleapis.com/auth/compute.readonly', +), + quota_project_id=None, + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.OsLoginServiceGrpcTransport, + transports.OsLoginServiceGrpcAsyncIOTransport, + ], +) +def test_os_login_service_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-platform.read-only', 'https://www.googleapis.com/auth/compute', 'https://www.googleapis.com/auth/compute.readonly',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize( + "transport_class", + [ + transports.OsLoginServiceGrpcTransport, + transports.OsLoginServiceGrpcAsyncIOTransport, + transports.OsLoginServiceRestTransport, + ], +) +def test_os_login_service_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.OsLoginServiceGrpcTransport, grpc_helpers), + (transports.OsLoginServiceGrpcAsyncIOTransport, grpc_helpers_async) + ], +) +def test_os_login_service_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( + "oslogin.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-platform.read-only', + 'https://www.googleapis.com/auth/compute', + 'https://www.googleapis.com/auth/compute.readonly', +), + scopes=["1", "2"], + default_host="oslogin.googleapis.com", + ssl_credentials=None, + options=[ + ("grpc.max_send_message_length", -1), + ("grpc.max_receive_message_length", -1), + ], + ) + + +@pytest.mark.parametrize("transport_class", [transports.OsLoginServiceGrpcTransport, transports.OsLoginServiceGrpcAsyncIOTransport]) +def test_os_login_service_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_os_login_service_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.OsLoginServiceRestTransport ( + 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_os_login_service_host_no_port(transport_name): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='oslogin.googleapis.com'), + transport=transport_name, + ) + assert client.transport._host == ( + 'oslogin.googleapis.com:443' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://oslogin.googleapis.com' + ) + +@pytest.mark.parametrize("transport_name", [ + "grpc", + "grpc_asyncio", + "rest", +]) +def test_os_login_service_host_with_port(transport_name): + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='oslogin.googleapis.com:8000'), + transport=transport_name, + ) + assert client.transport._host == ( + 'oslogin.googleapis.com:8000' + if transport_name in ['grpc', 'grpc_asyncio'] + else 'https://oslogin.googleapis.com:8000' + ) + +@pytest.mark.parametrize("transport_name", [ + "rest", +]) +def test_os_login_service_client_transport_session_collision(transport_name): + creds1 = ga_credentials.AnonymousCredentials() + creds2 = ga_credentials.AnonymousCredentials() + client1 = OsLoginServiceClient( + credentials=creds1, + transport=transport_name, + ) + client2 = OsLoginServiceClient( + credentials=creds2, + transport=transport_name, + ) + session1 = client1.transport.create_ssh_public_key._session + session2 = client2.transport.create_ssh_public_key._session + assert session1 != session2 + session1 = client1.transport.delete_posix_account._session + session2 = client2.transport.delete_posix_account._session + assert session1 != session2 + session1 = client1.transport.delete_ssh_public_key._session + session2 = client2.transport.delete_ssh_public_key._session + assert session1 != session2 + session1 = client1.transport.get_login_profile._session + session2 = client2.transport.get_login_profile._session + assert session1 != session2 + session1 = client1.transport.get_ssh_public_key._session + session2 = client2.transport.get_ssh_public_key._session + assert session1 != session2 + session1 = client1.transport.import_ssh_public_key._session + session2 = client2.transport.import_ssh_public_key._session + assert session1 != session2 + session1 = client1.transport.update_ssh_public_key._session + session2 = client2.transport.update_ssh_public_key._session + assert session1 != session2 +def test_os_login_service_grpc_transport_channel(): + channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.OsLoginServiceGrpcTransport( + 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_os_login_service_grpc_asyncio_transport_channel(): + channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) + + # Check that channel is used if provided. + transport = transports.OsLoginServiceGrpcAsyncIOTransport( + 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.OsLoginServiceGrpcTransport, transports.OsLoginServiceGrpcAsyncIOTransport]) +def test_os_login_service_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.OsLoginServiceGrpcTransport, transports.OsLoginServiceGrpcAsyncIOTransport]) +def test_os_login_service_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_posix_account_path(): + user = "squid" + project = "clam" + expected = "users/{user}/projects/{project}".format(user=user, project=project, ) + actual = OsLoginServiceClient.posix_account_path(user, project) + assert expected == actual + + +def test_parse_posix_account_path(): + expected = { + "user": "whelk", + "project": "octopus", + } + path = OsLoginServiceClient.posix_account_path(**expected) + + # Check that the path construction is reversible. + actual = OsLoginServiceClient.parse_posix_account_path(path) + assert expected == actual + +def test_ssh_public_key_path(): + user = "oyster" + fingerprint = "nudibranch" + expected = "users/{user}/sshPublicKeys/{fingerprint}".format(user=user, fingerprint=fingerprint, ) + actual = OsLoginServiceClient.ssh_public_key_path(user, fingerprint) + assert expected == actual + + +def test_parse_ssh_public_key_path(): + expected = { + "user": "cuttlefish", + "fingerprint": "mussel", + } + path = OsLoginServiceClient.ssh_public_key_path(**expected) + + # Check that the path construction is reversible. + actual = OsLoginServiceClient.parse_ssh_public_key_path(path) + assert expected == actual + +def test_common_billing_account_path(): + billing_account = "winkle" + expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) + actual = OsLoginServiceClient.common_billing_account_path(billing_account) + assert expected == actual + + +def test_parse_common_billing_account_path(): + expected = { + "billing_account": "nautilus", + } + path = OsLoginServiceClient.common_billing_account_path(**expected) + + # Check that the path construction is reversible. + actual = OsLoginServiceClient.parse_common_billing_account_path(path) + assert expected == actual + +def test_common_folder_path(): + folder = "scallop" + expected = "folders/{folder}".format(folder=folder, ) + actual = OsLoginServiceClient.common_folder_path(folder) + assert expected == actual + + +def test_parse_common_folder_path(): + expected = { + "folder": "abalone", + } + path = OsLoginServiceClient.common_folder_path(**expected) + + # Check that the path construction is reversible. + actual = OsLoginServiceClient.parse_common_folder_path(path) + assert expected == actual + +def test_common_organization_path(): + organization = "squid" + expected = "organizations/{organization}".format(organization=organization, ) + actual = OsLoginServiceClient.common_organization_path(organization) + assert expected == actual + + +def test_parse_common_organization_path(): + expected = { + "organization": "clam", + } + path = OsLoginServiceClient.common_organization_path(**expected) + + # Check that the path construction is reversible. + actual = OsLoginServiceClient.parse_common_organization_path(path) + assert expected == actual + +def test_common_project_path(): + project = "whelk" + expected = "projects/{project}".format(project=project, ) + actual = OsLoginServiceClient.common_project_path(project) + assert expected == actual + + +def test_parse_common_project_path(): + expected = { + "project": "octopus", + } + path = OsLoginServiceClient.common_project_path(**expected) + + # Check that the path construction is reversible. + actual = OsLoginServiceClient.parse_common_project_path(path) + assert expected == actual + +def test_common_location_path(): + project = "oyster" + location = "nudibranch" + expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) + actual = OsLoginServiceClient.common_location_path(project, location) + assert expected == actual + + +def test_parse_common_location_path(): + expected = { + "project": "cuttlefish", + "location": "mussel", + } + path = OsLoginServiceClient.common_location_path(**expected) + + # Check that the path construction is reversible. + actual = OsLoginServiceClient.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.OsLoginServiceTransport, '_prep_wrapped_messages') as prep: + client = OsLoginServiceClient( + credentials=ga_credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) + + with mock.patch.object(transports.OsLoginServiceTransport, '_prep_wrapped_messages') as prep: + transport_class = OsLoginServiceClient.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 = OsLoginServiceAsyncClient( + 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 = OsLoginServiceClient( + 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 = OsLoginServiceClient( + 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", [ + (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport), + (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport), +]) +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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), + 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 5940a0ae2af2c28156cdc0d9efb6adc47616d79b Mon Sep 17 00:00:00 2001 From: Owl Bot Date: Tue, 25 Jun 2024 01:57:57 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=A6=89=20Updates=20from=20OwlBot=20po?= =?UTF-8?q?st-processor?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --- .../google-cloud-os-login/v1/.coveragerc | 13 - .../google-cloud-os-login/v1/.flake8 | 33 - .../google-cloud-os-login/v1/MANIFEST.in | 2 - .../google-cloud-os-login/v1/README.rst | 49 - .../v1/docs/_static/custom.css | 3 - .../google-cloud-os-login/v1/docs/conf.py | 376 - .../google-cloud-os-login/v1/docs/index.rst | 7 - .../v1/docs/oslogin_v1/os_login_service.rst | 6 - .../v1/docs/oslogin_v1/services_.rst | 6 - .../v1/docs/oslogin_v1/types_.rst | 6 - .../v1/google/cloud/oslogin/__init__.py | 45 - .../v1/google/cloud/oslogin/gapic_version.py | 16 - .../v1/google/cloud/oslogin/py.typed | 2 - .../v1/google/cloud/oslogin_v1/__init__.py | 46 - .../cloud/oslogin_v1/gapic_metadata.json | 133 - .../google/cloud/oslogin_v1/gapic_version.py | 16 - .../v1/google/cloud/oslogin_v1/py.typed | 2 - .../cloud/oslogin_v1/services/__init__.py | 15 - .../services/os_login_service/__init__.py | 22 - .../services/os_login_service/async_client.py | 1008 --- .../services/os_login_service/client.py | 1366 ---- .../os_login_service/transports/__init__.py | 38 - .../os_login_service/transports/base.py | 301 - .../os_login_service/transports/grpc.py | 436 -- .../transports/grpc_asyncio.py | 536 -- .../os_login_service/transports/rest.py | 941 --- .../google/cloud/oslogin_v1/types/__init__.py | 38 - .../google/cloud/oslogin_v1/types/oslogin.py | 271 - .../google-cloud-os-login/v1/mypy.ini | 3 - .../google-cloud-os-login/v1/noxfile.py | 253 - ...gin_service_create_ssh_public_key_async.py | 52 - ...ogin_service_create_ssh_public_key_sync.py | 52 - ...ogin_service_delete_posix_account_async.py | 50 - ...login_service_delete_posix_account_sync.py | 50 - ...gin_service_delete_ssh_public_key_async.py | 50 - ...ogin_service_delete_ssh_public_key_sync.py | 50 - ...s_login_service_get_login_profile_async.py | 52 - ...os_login_service_get_login_profile_sync.py | 52 - ..._login_service_get_ssh_public_key_async.py | 52 - ...s_login_service_get_ssh_public_key_sync.py | 52 - ...gin_service_import_ssh_public_key_async.py | 52 - ...ogin_service_import_ssh_public_key_sync.py | 52 - ...gin_service_update_ssh_public_key_async.py | 52 - ...ogin_service_update_ssh_public_key_sync.py | 52 - ...ppet_metadata_google.cloud.oslogin.v1.json | 1170 ---- .../v1/scripts/fixup_oslogin_v1_keywords.py | 182 - .../google-cloud-os-login/v1/setup.py | 93 - .../v1/testing/constraints-3.10.txt | 6 - .../v1/testing/constraints-3.11.txt | 6 - .../v1/testing/constraints-3.12.txt | 6 - .../v1/testing/constraints-3.7.txt | 10 - .../v1/testing/constraints-3.8.txt | 6 - .../v1/testing/constraints-3.9.txt | 6 - .../v1/tests/__init__.py | 16 - .../v1/tests/unit/__init__.py | 16 - .../v1/tests/unit/gapic/__init__.py | 16 - .../tests/unit/gapic/oslogin_v1/__init__.py | 16 - .../gapic/oslogin_v1/test_os_login_service.py | 6129 ----------------- packages/google-cloud-os-login/README.rst | 2 +- packages/google-cloud-os-login/docs/index.rst | 5 + .../docs/summary_overview.md | 22 + packages/google-cloud-os-login/noxfile.py | 46 +- 62 files changed, 63 insertions(+), 14399 deletions(-) delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/.coveragerc delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/.flake8 delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/MANIFEST.in delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/README.rst delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/docs/_static/custom.css delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/docs/conf.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/docs/index.rst delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/os_login_service.rst delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/services_.rst delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/types_.rst delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/__init__.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/gapic_version.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/py.typed delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/__init__.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_metadata.json delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_version.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/py.typed delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/__init__.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/client.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/rest.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/__init__.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/oslogin.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/mypy.ini delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/noxfile.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_async.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_sync.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_async.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_sync.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_async.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_sync.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_async.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_sync.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_async.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_sync.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_async.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_sync.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_async.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_sync.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/snippet_metadata_google.cloud.oslogin.v1.json delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/scripts/fixup_oslogin_v1_keywords.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/setup.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.10.txt delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.11.txt delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.12.txt delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.7.txt delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.8.txt delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.9.txt delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/tests/__init__.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/tests/unit/__init__.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/__init__.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/__init__.py delete mode 100644 owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py create mode 100644 packages/google-cloud-os-login/docs/summary_overview.md diff --git a/owl-bot-staging/google-cloud-os-login/v1/.coveragerc b/owl-bot-staging/google-cloud-os-login/v1/.coveragerc deleted file mode 100644 index 5de532f89801..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/.coveragerc +++ /dev/null @@ -1,13 +0,0 @@ -[run] -branch = True - -[report] -show_missing = True -omit = - google/cloud/oslogin/__init__.py - google/cloud/oslogin/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/google-cloud-os-login/v1/.flake8 b/owl-bot-staging/google-cloud-os-login/v1/.flake8 deleted file mode 100644 index 29227d4cf419..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/.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/google-cloud-os-login/v1/MANIFEST.in b/owl-bot-staging/google-cloud-os-login/v1/MANIFEST.in deleted file mode 100644 index 855fae674325..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/oslogin *.py -recursive-include google/cloud/oslogin_v1 *.py diff --git a/owl-bot-staging/google-cloud-os-login/v1/README.rst b/owl-bot-staging/google-cloud-os-login/v1/README.rst deleted file mode 100644 index db2bd84ed7e1..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Oslogin 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 Oslogin 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/google-cloud-os-login/v1/docs/_static/custom.css b/owl-bot-staging/google-cloud-os-login/v1/docs/_static/custom.css deleted file mode 100644 index 06423be0b592..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/docs/_static/custom.css +++ /dev/null @@ -1,3 +0,0 @@ -dl.field-list > dt { - min-width: 100px -} diff --git a/owl-bot-staging/google-cloud-os-login/v1/docs/conf.py b/owl-bot-staging/google-cloud-os-login/v1/docs/conf.py deleted file mode 100644 index 0187fbfa0cd1..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/docs/conf.py +++ /dev/null @@ -1,376 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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-os-login 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-os-login" -copyright = u"2023, 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 = 'en' - -# 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-os-login-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-os-login.tex", - u"google-cloud-os-login 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-os-login", - u"Google Cloud Oslogin 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-os-login", - u"google-cloud-os-login Documentation", - author, - "google-cloud-os-login", - "GAPIC library for Google Cloud Oslogin 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/google-cloud-os-login/v1/docs/index.rst b/owl-bot-staging/google-cloud-os-login/v1/docs/index.rst deleted file mode 100644 index 76e15ba81fe8..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - oslogin_v1/services - oslogin_v1/types diff --git a/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/os_login_service.rst b/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/os_login_service.rst deleted file mode 100644 index 588b1fb7b214..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/os_login_service.rst +++ /dev/null @@ -1,6 +0,0 @@ -OsLoginService --------------------------------- - -.. automodule:: google.cloud.oslogin_v1.services.os_login_service - :members: - :inherited-members: diff --git a/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/services_.rst b/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/services_.rst deleted file mode 100644 index 10a71557c528..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/services_.rst +++ /dev/null @@ -1,6 +0,0 @@ -Services for Google Cloud Oslogin v1 API -======================================== -.. toctree:: - :maxdepth: 2 - - os_login_service diff --git a/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/types_.rst b/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/types_.rst deleted file mode 100644 index ad7f7feaff01..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/docs/oslogin_v1/types_.rst +++ /dev/null @@ -1,6 +0,0 @@ -Types for Google Cloud Oslogin v1 API -===================================== - -.. automodule:: google.cloud.oslogin_v1.types - :members: - :show-inheritance: diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/__init__.py deleted file mode 100644 index 70e2899cea16..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/__init__.py +++ /dev/null @@ -1,45 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.oslogin import gapic_version as package_version - -__version__ = package_version.__version__ - - -from google.cloud.oslogin_v1.services.os_login_service.client import OsLoginServiceClient -from google.cloud.oslogin_v1.services.os_login_service.async_client import OsLoginServiceAsyncClient - -from google.cloud.oslogin_v1.types.oslogin import CreateSshPublicKeyRequest -from google.cloud.oslogin_v1.types.oslogin import DeletePosixAccountRequest -from google.cloud.oslogin_v1.types.oslogin import DeleteSshPublicKeyRequest -from google.cloud.oslogin_v1.types.oslogin import GetLoginProfileRequest -from google.cloud.oslogin_v1.types.oslogin import GetSshPublicKeyRequest -from google.cloud.oslogin_v1.types.oslogin import ImportSshPublicKeyRequest -from google.cloud.oslogin_v1.types.oslogin import ImportSshPublicKeyResponse -from google.cloud.oslogin_v1.types.oslogin import LoginProfile -from google.cloud.oslogin_v1.types.oslogin import UpdateSshPublicKeyRequest - -__all__ = ('OsLoginServiceClient', - 'OsLoginServiceAsyncClient', - 'CreateSshPublicKeyRequest', - 'DeletePosixAccountRequest', - 'DeleteSshPublicKeyRequest', - 'GetLoginProfileRequest', - 'GetSshPublicKeyRequest', - 'ImportSshPublicKeyRequest', - 'ImportSshPublicKeyResponse', - 'LoginProfile', - 'UpdateSshPublicKeyRequest', -) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/gapic_version.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/gapic_version.py deleted file mode 100644 index 558c8aab67c5..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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/google-cloud-os-login/v1/google/cloud/oslogin/py.typed b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/py.typed deleted file mode 100644 index 1a80e6c43390..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-os-login package uses inline types. diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/__init__.py deleted file mode 100644 index fbaca75ec964..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/__init__.py +++ /dev/null @@ -1,46 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.oslogin_v1 import gapic_version as package_version - -__version__ = package_version.__version__ - - -from .services.os_login_service import OsLoginServiceClient -from .services.os_login_service import OsLoginServiceAsyncClient - -from .types.oslogin import CreateSshPublicKeyRequest -from .types.oslogin import DeletePosixAccountRequest -from .types.oslogin import DeleteSshPublicKeyRequest -from .types.oslogin import GetLoginProfileRequest -from .types.oslogin import GetSshPublicKeyRequest -from .types.oslogin import ImportSshPublicKeyRequest -from .types.oslogin import ImportSshPublicKeyResponse -from .types.oslogin import LoginProfile -from .types.oslogin import UpdateSshPublicKeyRequest - -__all__ = ( - 'OsLoginServiceAsyncClient', -'CreateSshPublicKeyRequest', -'DeletePosixAccountRequest', -'DeleteSshPublicKeyRequest', -'GetLoginProfileRequest', -'GetSshPublicKeyRequest', -'ImportSshPublicKeyRequest', -'ImportSshPublicKeyResponse', -'LoginProfile', -'OsLoginServiceClient', -'UpdateSshPublicKeyRequest', -) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_metadata.json b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_metadata.json deleted file mode 100644 index 61118fd98b22..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_metadata.json +++ /dev/null @@ -1,133 +0,0 @@ - { - "comment": "This file maps proto services/RPCs to the corresponding library clients/methods", - "language": "python", - "libraryPackage": "google.cloud.oslogin_v1", - "protoPackage": "google.cloud.oslogin.v1", - "schema": "1.0", - "services": { - "OsLoginService": { - "clients": { - "grpc": { - "libraryClient": "OsLoginServiceClient", - "rpcs": { - "CreateSshPublicKey": { - "methods": [ - "create_ssh_public_key" - ] - }, - "DeletePosixAccount": { - "methods": [ - "delete_posix_account" - ] - }, - "DeleteSshPublicKey": { - "methods": [ - "delete_ssh_public_key" - ] - }, - "GetLoginProfile": { - "methods": [ - "get_login_profile" - ] - }, - "GetSshPublicKey": { - "methods": [ - "get_ssh_public_key" - ] - }, - "ImportSshPublicKey": { - "methods": [ - "import_ssh_public_key" - ] - }, - "UpdateSshPublicKey": { - "methods": [ - "update_ssh_public_key" - ] - } - } - }, - "grpc-async": { - "libraryClient": "OsLoginServiceAsyncClient", - "rpcs": { - "CreateSshPublicKey": { - "methods": [ - "create_ssh_public_key" - ] - }, - "DeletePosixAccount": { - "methods": [ - "delete_posix_account" - ] - }, - "DeleteSshPublicKey": { - "methods": [ - "delete_ssh_public_key" - ] - }, - "GetLoginProfile": { - "methods": [ - "get_login_profile" - ] - }, - "GetSshPublicKey": { - "methods": [ - "get_ssh_public_key" - ] - }, - "ImportSshPublicKey": { - "methods": [ - "import_ssh_public_key" - ] - }, - "UpdateSshPublicKey": { - "methods": [ - "update_ssh_public_key" - ] - } - } - }, - "rest": { - "libraryClient": "OsLoginServiceClient", - "rpcs": { - "CreateSshPublicKey": { - "methods": [ - "create_ssh_public_key" - ] - }, - "DeletePosixAccount": { - "methods": [ - "delete_posix_account" - ] - }, - "DeleteSshPublicKey": { - "methods": [ - "delete_ssh_public_key" - ] - }, - "GetLoginProfile": { - "methods": [ - "get_login_profile" - ] - }, - "GetSshPublicKey": { - "methods": [ - "get_ssh_public_key" - ] - }, - "ImportSshPublicKey": { - "methods": [ - "import_ssh_public_key" - ] - }, - "UpdateSshPublicKey": { - "methods": [ - "update_ssh_public_key" - ] - } - } - } - } - } - } -} diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_version.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_version.py deleted file mode 100644 index 558c8aab67c5..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/gapic_version.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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/google-cloud-os-login/v1/google/cloud/oslogin_v1/py.typed b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/py.typed deleted file mode 100644 index 1a80e6c43390..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-os-login package uses inline types. diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/__init__.py deleted file mode 100644 index 8f6cf068242c..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/__init__.py +++ /dev/null @@ -1,15 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py deleted file mode 100644 index 347571e25212..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py +++ /dev/null @@ -1,22 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 OsLoginServiceClient -from .async_client import OsLoginServiceAsyncClient - -__all__ = ( - 'OsLoginServiceClient', - 'OsLoginServiceAsyncClient', -) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py deleted file mode 100644 index 37ff0a733d44..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py +++ /dev/null @@ -1,1008 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union - -from google.cloud.oslogin_v1 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_async as retries -from google.auth import credentials as ga_credentials # type: ignore -from google.oauth2 import service_account # type: ignore - - -try: - OptionalRetry = Union[retries.AsyncRetry, gapic_v1.method._MethodDefault, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.AsyncRetry, object, None] # type: ignore - -from google.cloud.oslogin.common.types import common -from google.cloud.oslogin_v1.types import oslogin -from google.protobuf import field_mask_pb2 # type: ignore -from .transports.base import OsLoginServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc_asyncio import OsLoginServiceGrpcAsyncIOTransport -from .client import OsLoginServiceClient - - -class OsLoginServiceAsyncClient: - """Cloud OS Login API - - The Cloud OS Login API allows you to manage users and their - associated SSH public keys for logging into virtual machines on - Google Cloud Platform. - """ - - _client: OsLoginServiceClient - - # Copy defaults from the synchronous client for use here. - # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. - DEFAULT_ENDPOINT = OsLoginServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = OsLoginServiceClient.DEFAULT_MTLS_ENDPOINT - _DEFAULT_ENDPOINT_TEMPLATE = OsLoginServiceClient._DEFAULT_ENDPOINT_TEMPLATE - _DEFAULT_UNIVERSE = OsLoginServiceClient._DEFAULT_UNIVERSE - - posix_account_path = staticmethod(OsLoginServiceClient.posix_account_path) - parse_posix_account_path = staticmethod(OsLoginServiceClient.parse_posix_account_path) - ssh_public_key_path = staticmethod(OsLoginServiceClient.ssh_public_key_path) - parse_ssh_public_key_path = staticmethod(OsLoginServiceClient.parse_ssh_public_key_path) - common_billing_account_path = staticmethod(OsLoginServiceClient.common_billing_account_path) - parse_common_billing_account_path = staticmethod(OsLoginServiceClient.parse_common_billing_account_path) - common_folder_path = staticmethod(OsLoginServiceClient.common_folder_path) - parse_common_folder_path = staticmethod(OsLoginServiceClient.parse_common_folder_path) - common_organization_path = staticmethod(OsLoginServiceClient.common_organization_path) - parse_common_organization_path = staticmethod(OsLoginServiceClient.parse_common_organization_path) - common_project_path = staticmethod(OsLoginServiceClient.common_project_path) - parse_common_project_path = staticmethod(OsLoginServiceClient.parse_common_project_path) - common_location_path = staticmethod(OsLoginServiceClient.common_location_path) - parse_common_location_path = staticmethod(OsLoginServiceClient.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: - OsLoginServiceAsyncClient: The constructed client. - """ - return OsLoginServiceClient.from_service_account_info.__func__(OsLoginServiceAsyncClient, 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: - OsLoginServiceAsyncClient: The constructed client. - """ - return OsLoginServiceClient.from_service_account_file.__func__(OsLoginServiceAsyncClient, 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 OsLoginServiceClient.get_mtls_endpoint_and_cert_source(client_options) # type: ignore - - @property - def transport(self) -> OsLoginServiceTransport: - """Returns the transport used by the client instance. - - Returns: - OsLoginServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - @property - def api_endpoint(self): - """Return the API endpoint used by the client instance. - - Returns: - str: The API endpoint used by the client instance. - """ - return self._client._api_endpoint - - @property - def universe_domain(self) -> str: - """Return the universe domain used by the client instance. - - Returns: - str: The universe domain used - by the client instance. - """ - return self._client._universe_domain - - get_transport_class = functools.partial(type(OsLoginServiceClient).get_transport_class, type(OsLoginServiceClient)) - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, OsLoginServiceTransport, Callable[..., OsLoginServiceTransport]]] = "grpc_asyncio", - client_options: Optional[ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the os login service async 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 (Optional[Union[str,OsLoginServiceTransport,Callable[..., OsLoginServiceTransport]]]): - The transport to use, or a Callable that constructs and returns a new transport to use. - If a Callable is given, it will be called with the same set of initialization - arguments as used in the OsLoginServiceTransport constructor. - 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. - - 1. The ``api_endpoint`` property can be used to override the - default endpoint provided by the client when ``transport`` is - not explicitly provided. Only if this property is not set and - ``transport`` was not explicitly provided, the endpoint is - determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment - variable, which have one of the following values: - "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). - - 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide a client certificate for mTLS 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. - - 3. The ``universe_domain`` property can be used to override the - default "googleapis.com" universe. Note that ``api_endpoint`` - property still takes precedence; and ``universe_domain`` is - currently not supported for mTLS. - - 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. - """ - self._client = OsLoginServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def create_ssh_public_key(self, - request: Optional[Union[oslogin.CreateSshPublicKeyRequest, dict]] = None, - *, - parent: Optional[str] = None, - ssh_public_key: Optional[common.SshPublicKey] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> common.SshPublicKey: - r"""Create an SSH public key - - .. 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 oslogin_v1 - - async def sample_create_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.CreateSshPublicKeyRequest( - parent="parent_value", - ) - - # Make the request - response = await client.create_ssh_public_key(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.oslogin_v1.types.CreateSshPublicKeyRequest, dict]]): - The request object. A request message for creating an SSH - public key. - parent (:class:`str`): - Required. The unique ID for the user in format - ``users/{user}``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - ssh_public_key (:class:`google.cloud.oslogin.common.types.SshPublicKey`): - Required. The SSH public key and - expiration time. - - This corresponds to the ``ssh_public_key`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be 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.oslogin.common.types.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - # 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([parent, ssh_public_key]) - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.CreateSshPublicKeyRequest): - request = oslogin.CreateSshPublicKeyRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if ssh_public_key is not None: - request.ssh_public_key = ssh_public_key - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.create_ssh_public_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def delete_posix_account(self, - request: Optional[Union[oslogin.DeletePosixAccountRequest, dict]] = None, - *, - name: 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 a POSIX account. - - .. 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 oslogin_v1 - - async def sample_delete_posix_account(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.DeletePosixAccountRequest( - name="name_value", - ) - - # Make the request - await client.delete_posix_account(request=request) - - Args: - request (Optional[Union[google.cloud.oslogin_v1.types.DeletePosixAccountRequest, dict]]): - The request object. A request message for deleting a - POSIX account entry. - name (:class:`str`): - Required. A reference to the POSIX account to update. - POSIX accounts are identified by the project ID they are - associated with. A reference to the POSIX account is in - format ``users/{user}/projects/{project}``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be 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([name]) - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.DeletePosixAccountRequest): - request = oslogin.DeletePosixAccountRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.delete_posix_account] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def delete_ssh_public_key(self, - request: Optional[Union[oslogin.DeleteSshPublicKeyRequest, dict]] = None, - *, - name: 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 an SSH public key. - - .. 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 oslogin_v1 - - async def sample_delete_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.DeleteSshPublicKeyRequest( - name="name_value", - ) - - # Make the request - await client.delete_ssh_public_key(request=request) - - Args: - request (Optional[Union[google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest, dict]]): - The request object. A request message for deleting an SSH - public key. - name (:class:`str`): - Required. The fingerprint of the public key to update. - Public keys are identified by their SHA-256 fingerprint. - The fingerprint of the public key is in format - ``users/{user}/sshPublicKeys/{fingerprint}``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be 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([name]) - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.DeleteSshPublicKeyRequest): - request = oslogin.DeleteSshPublicKeyRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.delete_ssh_public_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def get_login_profile(self, - request: Optional[Union[oslogin.GetLoginProfileRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> oslogin.LoginProfile: - r"""Retrieves the profile information used for logging in - to a virtual machine on Google Compute Engine. - - .. 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 oslogin_v1 - - async def sample_get_login_profile(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.GetLoginProfileRequest( - name="name_value", - ) - - # Make the request - response = await client.get_login_profile(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.oslogin_v1.types.GetLoginProfileRequest, dict]]): - The request object. A request message for retrieving the - login profile information for a user. - name (:class:`str`): - Required. The unique ID for the user in format - ``users/{user}``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be 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.oslogin_v1.types.LoginProfile: - The user profile information used for - logging in to a virtual machine on - Google Compute Engine. - - """ - # 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([name]) - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.GetLoginProfileRequest): - request = oslogin.GetLoginProfileRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.get_login_profile] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def get_ssh_public_key(self, - request: Optional[Union[oslogin.GetSshPublicKeyRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> common.SshPublicKey: - r"""Retrieves an SSH public key. - - .. 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 oslogin_v1 - - async def sample_get_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.GetSshPublicKeyRequest( - name="name_value", - ) - - # Make the request - response = await client.get_ssh_public_key(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.oslogin_v1.types.GetSshPublicKeyRequest, dict]]): - The request object. A request message for retrieving an - SSH public key. - name (:class:`str`): - Required. The fingerprint of the public key to retrieve. - Public keys are identified by their SHA-256 fingerprint. - The fingerprint of the public key is in format - ``users/{user}/sshPublicKeys/{fingerprint}``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be 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.oslogin.common.types.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - # 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([name]) - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.GetSshPublicKeyRequest): - request = oslogin.GetSshPublicKeyRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.get_ssh_public_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def import_ssh_public_key(self, - request: Optional[Union[oslogin.ImportSshPublicKeyRequest, dict]] = None, - *, - parent: Optional[str] = None, - ssh_public_key: Optional[common.SshPublicKey] = None, - project_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> oslogin.ImportSshPublicKeyResponse: - r"""Adds an SSH public key and returns the profile - information. Default POSIX account information is set - when no username and UID exist as part of the login - profile. - - .. 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 oslogin_v1 - - async def sample_import_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.ImportSshPublicKeyRequest( - parent="parent_value", - ) - - # Make the request - response = await client.import_ssh_public_key(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest, dict]]): - The request object. A request message for importing an - SSH public key. - parent (:class:`str`): - Required. The unique ID for the user in format - ``users/{user}``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - ssh_public_key (:class:`google.cloud.oslogin.common.types.SshPublicKey`): - Optional. The SSH public key and - expiration time. - - This corresponds to the ``ssh_public_key`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - project_id (:class:`str`): - The project ID of the Google Cloud - Platform project. - - This corresponds to the ``project_id`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be 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.oslogin_v1.types.ImportSshPublicKeyResponse: - A response message for importing an - SSH public key. - - """ - # 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([parent, ssh_public_key, project_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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.ImportSshPublicKeyRequest): - request = oslogin.ImportSshPublicKeyRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if ssh_public_key is not None: - request.ssh_public_key = ssh_public_key - if project_id is not None: - request.project_id = project_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.import_ssh_public_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def update_ssh_public_key(self, - request: Optional[Union[oslogin.UpdateSshPublicKeyRequest, dict]] = None, - *, - name: Optional[str] = None, - ssh_public_key: Optional[common.SshPublicKey] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> common.SshPublicKey: - r"""Updates an SSH public key and returns the profile - information. This method supports patch semantics. - - .. 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 oslogin_v1 - - async def sample_update_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.UpdateSshPublicKeyRequest( - name="name_value", - ) - - # Make the request - response = await client.update_ssh_public_key(request=request) - - # Handle the response - print(response) - - Args: - request (Optional[Union[google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest, dict]]): - The request object. A request message for updating an SSH - public key. - name (:class:`str`): - Required. The fingerprint of the public key to update. - Public keys are identified by their SHA-256 fingerprint. - The fingerprint of the public key is in format - ``users/{user}/sshPublicKeys/{fingerprint}``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - ssh_public_key (:class:`google.cloud.oslogin.common.types.SshPublicKey`): - Required. The SSH public key and - expiration time. - - This corresponds to the ``ssh_public_key`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`): - Mask to control which fields get - updated. Updates all if not present. - - This corresponds to the ``update_mask`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any, - should be 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.oslogin.common.types.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - # 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([name, ssh_public_key, update_mask]) - 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.") - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.UpdateSshPublicKeyRequest): - request = oslogin.UpdateSshPublicKeyRequest(request) - - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if ssh_public_key is not None: - request.ssh_public_key = ssh_public_key - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._client._transport._wrapped_methods[self._client._transport.update_ssh_public_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Validate the universe domain. - self._client._validate_universe_domain() - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - async def __aenter__(self) -> "OsLoginServiceAsyncClient": - 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__ = ( - "OsLoginServiceAsyncClient", -) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/client.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/client.py deleted file mode 100644 index 8a1295701604..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/client.py +++ /dev/null @@ -1,1366 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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, Callable, Mapping, MutableMapping, MutableSequence, Optional, Sequence, Tuple, Type, Union, cast -import warnings - -from google.cloud.oslogin_v1 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, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object, None] # type: ignore - -from google.cloud.oslogin.common.types import common -from google.cloud.oslogin_v1.types import oslogin -from google.protobuf import field_mask_pb2 # type: ignore -from .transports.base import OsLoginServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import OsLoginServiceGrpcTransport -from .transports.grpc_asyncio import OsLoginServiceGrpcAsyncIOTransport -from .transports.rest import OsLoginServiceRestTransport - - -class OsLoginServiceClientMeta(type): - """Metaclass for the OsLoginService 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[OsLoginServiceTransport]] - _transport_registry["grpc"] = OsLoginServiceGrpcTransport - _transport_registry["grpc_asyncio"] = OsLoginServiceGrpcAsyncIOTransport - _transport_registry["rest"] = OsLoginServiceRestTransport - - def get_transport_class(cls, - label: Optional[str] = None, - ) -> Type[OsLoginServiceTransport]: - """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 OsLoginServiceClient(metaclass=OsLoginServiceClientMeta): - """Cloud OS Login API - - The Cloud OS Login API allows you to manage users and their - associated SSH public keys for logging into virtual machines on - Google Cloud Platform. - """ - - @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") - - # Note: DEFAULT_ENDPOINT is deprecated. Use _DEFAULT_ENDPOINT_TEMPLATE instead. - DEFAULT_ENDPOINT = "oslogin.googleapis.com" - DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore - DEFAULT_ENDPOINT - ) - - _DEFAULT_ENDPOINT_TEMPLATE = "oslogin.{UNIVERSE_DOMAIN}" - _DEFAULT_UNIVERSE = "googleapis.com" - - @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: - OsLoginServiceClient: 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: - OsLoginServiceClient: 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) -> OsLoginServiceTransport: - """Returns the transport used by the client instance. - - Returns: - OsLoginServiceTransport: The transport used by the client - instance. - """ - return self._transport - - @staticmethod - def posix_account_path(user: str,project: str,) -> str: - """Returns a fully-qualified posix_account string.""" - return "users/{user}/projects/{project}".format(user=user, project=project, ) - - @staticmethod - def parse_posix_account_path(path: str) -> Dict[str,str]: - """Parses a posix_account path into its component segments.""" - m = re.match(r"^users/(?P.+?)/projects/(?P.+?)$", path) - return m.groupdict() if m else {} - - @staticmethod - def ssh_public_key_path(user: str,fingerprint: str,) -> str: - """Returns a fully-qualified ssh_public_key string.""" - return "users/{user}/sshPublicKeys/{fingerprint}".format(user=user, fingerprint=fingerprint, ) - - @staticmethod - def parse_ssh_public_key_path(path: str) -> Dict[str,str]: - """Parses a ssh_public_key path into its component segments.""" - m = re.match(r"^users/(?P.+?)/sshPublicKeys/(?P.+?)$", path) - return m.groupdict() if m else {} - - @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): - """Deprecated. 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. - """ - - warnings.warn("get_mtls_endpoint_and_cert_source is deprecated. Use the api_endpoint property instead.", - DeprecationWarning) - 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 - - @staticmethod - def _read_environment_variables(): - """Returns the environment variables used by the client. - - Returns: - Tuple[bool, str, str]: returns the GOOGLE_API_USE_CLIENT_CERTIFICATE, - GOOGLE_API_USE_MTLS_ENDPOINT, and GOOGLE_CLOUD_UNIVERSE_DOMAIN environment variables. - - Raises: - ValueError: If GOOGLE_API_USE_CLIENT_CERTIFICATE is not - any of ["true", "false"]. - google.auth.exceptions.MutualTLSChannelError: If GOOGLE_API_USE_MTLS_ENDPOINT - is not any of ["auto", "never", "always"]. - """ - use_client_cert = os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false").lower() - use_mtls_endpoint = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto").lower() - universe_domain_env = os.getenv("GOOGLE_CLOUD_UNIVERSE_DOMAIN") - 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`") - return use_client_cert == "true", use_mtls_endpoint, universe_domain_env - - @staticmethod - def _get_client_cert_source(provided_cert_source, use_cert_flag): - """Return the client cert source to be used by the client. - - Args: - provided_cert_source (bytes): The client certificate source provided. - use_cert_flag (bool): A flag indicating whether to use the client certificate. - - Returns: - bytes or None: The client cert source to be used by the client. - """ - client_cert_source = None - if use_cert_flag: - if provided_cert_source: - client_cert_source = provided_cert_source - elif mtls.has_default_client_cert_source(): - client_cert_source = mtls.default_client_cert_source() - return client_cert_source - - @staticmethod - def _get_api_endpoint(api_override, client_cert_source, universe_domain, use_mtls_endpoint): - """Return the API endpoint used by the client. - - Args: - api_override (str): The API endpoint override. If specified, this is always - the return value of this function and the other arguments are not used. - client_cert_source (bytes): The client certificate source used by the client. - universe_domain (str): The universe domain used by the client. - use_mtls_endpoint (str): How to use the mTLS endpoint, which depends also on the other parameters. - Possible values are "always", "auto", or "never". - - Returns: - str: The API endpoint to be used by the client. - """ - if api_override is not None: - api_endpoint = api_override - elif use_mtls_endpoint == "always" or (use_mtls_endpoint == "auto" and client_cert_source): - _default_universe = OsLoginServiceClient._DEFAULT_UNIVERSE - if universe_domain != _default_universe: - raise MutualTLSChannelError(f"mTLS is not supported in any universe other than {_default_universe}.") - api_endpoint = OsLoginServiceClient.DEFAULT_MTLS_ENDPOINT - else: - api_endpoint = OsLoginServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=universe_domain) - return api_endpoint - - @staticmethod - def _get_universe_domain(client_universe_domain: Optional[str], universe_domain_env: Optional[str]) -> str: - """Return the universe domain used by the client. - - Args: - client_universe_domain (Optional[str]): The universe domain configured via the client options. - universe_domain_env (Optional[str]): The universe domain configured via the "GOOGLE_CLOUD_UNIVERSE_DOMAIN" environment variable. - - Returns: - str: The universe domain to be used by the client. - - Raises: - ValueError: If the universe domain is an empty string. - """ - universe_domain = OsLoginServiceClient._DEFAULT_UNIVERSE - if client_universe_domain is not None: - universe_domain = client_universe_domain - elif universe_domain_env is not None: - universe_domain = universe_domain_env - if len(universe_domain.strip()) == 0: - raise ValueError("Universe Domain cannot be an empty string.") - return universe_domain - - @staticmethod - def _compare_universes(client_universe: str, - credentials: ga_credentials.Credentials) -> bool: - """Returns True iff the universe domains used by the client and credentials match. - - Args: - client_universe (str): The universe domain configured via the client options. - credentials (ga_credentials.Credentials): The credentials being used in the client. - - Returns: - bool: True iff client_universe matches the universe in credentials. - - Raises: - ValueError: when client_universe does not match the universe in credentials. - """ - - default_universe = OsLoginServiceClient._DEFAULT_UNIVERSE - credentials_universe = getattr(credentials, "universe_domain", default_universe) - - if client_universe != credentials_universe: - raise ValueError("The configured universe domain " - f"({client_universe}) does not match the universe domain " - f"found in the credentials ({credentials_universe}). " - "If you haven't configured the universe domain explicitly, " - f"`{default_universe}` is the default.") - return True - - def _validate_universe_domain(self): - """Validates client's and credentials' universe domains are consistent. - - Returns: - bool: True iff the configured universe domain is valid. - - Raises: - ValueError: If the configured universe domain is not valid. - """ - self._is_universe_domain_valid = (self._is_universe_domain_valid or - OsLoginServiceClient._compare_universes(self.universe_domain, self.transport._credentials)) - return self._is_universe_domain_valid - - @property - def api_endpoint(self): - """Return the API endpoint used by the client instance. - - Returns: - str: The API endpoint used by the client instance. - """ - return self._api_endpoint - - @property - def universe_domain(self) -> str: - """Return the universe domain used by the client instance. - - Returns: - str: The universe domain used by the client instance. - """ - return self._universe_domain - - def __init__(self, *, - credentials: Optional[ga_credentials.Credentials] = None, - transport: Optional[Union[str, OsLoginServiceTransport, Callable[..., OsLoginServiceTransport]]] = None, - client_options: Optional[Union[client_options_lib.ClientOptions, dict]] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiates the os login service 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 (Optional[Union[str,OsLoginServiceTransport,Callable[..., OsLoginServiceTransport]]]): - The transport to use, or a Callable that constructs and returns a new transport. - If a Callable is given, it will be called with the same set of initialization - arguments as used in the OsLoginServiceTransport constructor. - 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. - - 1. The ``api_endpoint`` property can be used to override the - default endpoint provided by the client when ``transport`` is - not explicitly provided. Only if this property is not set and - ``transport`` was not explicitly provided, the endpoint is - determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment - variable, which have one of the following values: - "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). - - 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide a client certificate for mTLS 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. - - 3. The ``universe_domain`` property can be used to override the - default "googleapis.com" universe. Note that the ``api_endpoint`` - property still takes precedence; and ``universe_domain`` is - currently not supported for mTLS. - - 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. - """ - self._client_options = client_options - if isinstance(self._client_options, dict): - self._client_options = client_options_lib.from_dict(self._client_options) - if self._client_options is None: - self._client_options = client_options_lib.ClientOptions() - self._client_options = cast(client_options_lib.ClientOptions, self._client_options) - - universe_domain_opt = getattr(self._client_options, 'universe_domain', None) - - self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = OsLoginServiceClient._read_environment_variables() - self._client_cert_source = OsLoginServiceClient._get_client_cert_source(self._client_options.client_cert_source, self._use_client_cert) - self._universe_domain = OsLoginServiceClient._get_universe_domain(universe_domain_opt, self._universe_domain_env) - self._api_endpoint = None # updated below, depending on `transport` - - # Initialize the universe domain validation. - self._is_universe_domain_valid = False - - api_key_value = getattr(self._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. - transport_provided = isinstance(transport, OsLoginServiceTransport) - if transport_provided: - # transport is a OsLoginServiceTransport instance. - if credentials or self._client_options.credentials_file or api_key_value: - raise ValueError("When providing a transport instance, " - "provide its credentials directly.") - if self._client_options.scopes: - raise ValueError( - "When providing a transport instance, provide its scopes " - "directly." - ) - self._transport = cast(OsLoginServiceTransport, transport) - self._api_endpoint = self._transport.host - - self._api_endpoint = (self._api_endpoint or - OsLoginServiceClient._get_api_endpoint( - self._client_options.api_endpoint, - self._client_cert_source, - self._universe_domain, - self._use_mtls_endpoint)) - - if not transport_provided: - 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_init: Union[Type[OsLoginServiceTransport], Callable[..., OsLoginServiceTransport]] = ( - type(self).get_transport_class(transport) - if isinstance(transport, str) or transport is None - else cast(Callable[..., OsLoginServiceTransport], transport) - ) - # initialize with the provided callable or the passed in class - self._transport = transport_init( - credentials=credentials, - credentials_file=self._client_options.credentials_file, - host=self._api_endpoint, - scopes=self._client_options.scopes, - client_cert_source_for_mtls=self._client_cert_source, - quota_project_id=self._client_options.quota_project_id, - client_info=client_info, - always_use_jwt_access=True, - api_audience=self._client_options.api_audience, - ) - - def create_ssh_public_key(self, - request: Optional[Union[oslogin.CreateSshPublicKeyRequest, dict]] = None, - *, - parent: Optional[str] = None, - ssh_public_key: Optional[common.SshPublicKey] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> common.SshPublicKey: - r"""Create an SSH public key - - .. 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 oslogin_v1 - - def sample_create_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.CreateSshPublicKeyRequest( - parent="parent_value", - ) - - # Make the request - response = client.create_ssh_public_key(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.oslogin_v1.types.CreateSshPublicKeyRequest, dict]): - The request object. A request message for creating an SSH - public key. - parent (str): - Required. The unique ID for the user in format - ``users/{user}``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - ssh_public_key (google.cloud.oslogin.common.types.SshPublicKey): - Required. The SSH public key and - expiration time. - - This corresponds to the ``ssh_public_key`` 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.oslogin.common.types.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - # 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([parent, ssh_public_key]) - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.CreateSshPublicKeyRequest): - request = oslogin.CreateSshPublicKeyRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if ssh_public_key is not None: - request.ssh_public_key = ssh_public_key - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.create_ssh_public_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def delete_posix_account(self, - request: Optional[Union[oslogin.DeletePosixAccountRequest, dict]] = None, - *, - name: 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 a POSIX account. - - .. 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 oslogin_v1 - - def sample_delete_posix_account(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.DeletePosixAccountRequest( - name="name_value", - ) - - # Make the request - client.delete_posix_account(request=request) - - Args: - request (Union[google.cloud.oslogin_v1.types.DeletePosixAccountRequest, dict]): - The request object. A request message for deleting a - POSIX account entry. - name (str): - Required. A reference to the POSIX account to update. - POSIX accounts are identified by the project ID they are - associated with. A reference to the POSIX account is in - format ``users/{user}/projects/{project}``. - - This corresponds to the ``name`` 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([name]) - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.DeletePosixAccountRequest): - request = oslogin.DeletePosixAccountRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.delete_posix_account] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def delete_ssh_public_key(self, - request: Optional[Union[oslogin.DeleteSshPublicKeyRequest, dict]] = None, - *, - name: 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 an SSH public key. - - .. 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 oslogin_v1 - - def sample_delete_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.DeleteSshPublicKeyRequest( - name="name_value", - ) - - # Make the request - client.delete_ssh_public_key(request=request) - - Args: - request (Union[google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest, dict]): - The request object. A request message for deleting an SSH - public key. - name (str): - Required. The fingerprint of the public key to update. - Public keys are identified by their SHA-256 fingerprint. - The fingerprint of the public key is in format - ``users/{user}/sshPublicKeys/{fingerprint}``. - - This corresponds to the ``name`` 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([name]) - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.DeleteSshPublicKeyRequest): - request = oslogin.DeleteSshPublicKeyRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.delete_ssh_public_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def get_login_profile(self, - request: Optional[Union[oslogin.GetLoginProfileRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> oslogin.LoginProfile: - r"""Retrieves the profile information used for logging in - to a virtual machine on Google Compute Engine. - - .. 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 oslogin_v1 - - def sample_get_login_profile(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.GetLoginProfileRequest( - name="name_value", - ) - - # Make the request - response = client.get_login_profile(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.oslogin_v1.types.GetLoginProfileRequest, dict]): - The request object. A request message for retrieving the - login profile information for a user. - name (str): - Required. The unique ID for the user in format - ``users/{user}``. - - This corresponds to the ``name`` 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.oslogin_v1.types.LoginProfile: - The user profile information used for - logging in to a virtual machine on - Google Compute Engine. - - """ - # 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([name]) - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.GetLoginProfileRequest): - request = oslogin.GetLoginProfileRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_login_profile] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def get_ssh_public_key(self, - request: Optional[Union[oslogin.GetSshPublicKeyRequest, dict]] = None, - *, - name: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> common.SshPublicKey: - r"""Retrieves an SSH public key. - - .. 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 oslogin_v1 - - def sample_get_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.GetSshPublicKeyRequest( - name="name_value", - ) - - # Make the request - response = client.get_ssh_public_key(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.oslogin_v1.types.GetSshPublicKeyRequest, dict]): - The request object. A request message for retrieving an - SSH public key. - name (str): - Required. The fingerprint of the public key to retrieve. - Public keys are identified by their SHA-256 fingerprint. - The fingerprint of the public key is in format - ``users/{user}/sshPublicKeys/{fingerprint}``. - - This corresponds to the ``name`` 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.oslogin.common.types.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - # 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([name]) - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.GetSshPublicKeyRequest): - request = oslogin.GetSshPublicKeyRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.get_ssh_public_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def import_ssh_public_key(self, - request: Optional[Union[oslogin.ImportSshPublicKeyRequest, dict]] = None, - *, - parent: Optional[str] = None, - ssh_public_key: Optional[common.SshPublicKey] = None, - project_id: Optional[str] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> oslogin.ImportSshPublicKeyResponse: - r"""Adds an SSH public key and returns the profile - information. Default POSIX account information is set - when no username and UID exist as part of the login - profile. - - .. 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 oslogin_v1 - - def sample_import_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.ImportSshPublicKeyRequest( - parent="parent_value", - ) - - # Make the request - response = client.import_ssh_public_key(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest, dict]): - The request object. A request message for importing an - SSH public key. - parent (str): - Required. The unique ID for the user in format - ``users/{user}``. - - This corresponds to the ``parent`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - ssh_public_key (google.cloud.oslogin.common.types.SshPublicKey): - Optional. The SSH public key and - expiration time. - - This corresponds to the ``ssh_public_key`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - project_id (str): - The project ID of the Google Cloud - Platform project. - - This corresponds to the ``project_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.oslogin_v1.types.ImportSshPublicKeyResponse: - A response message for importing an - SSH public key. - - """ - # 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([parent, ssh_public_key, project_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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.ImportSshPublicKeyRequest): - request = oslogin.ImportSshPublicKeyRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if parent is not None: - request.parent = parent - if ssh_public_key is not None: - request.ssh_public_key = ssh_public_key - if project_id is not None: - request.project_id = project_id - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.import_ssh_public_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("parent", request.parent), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def update_ssh_public_key(self, - request: Optional[Union[oslogin.UpdateSshPublicKeyRequest, dict]] = None, - *, - name: Optional[str] = None, - ssh_public_key: Optional[common.SshPublicKey] = None, - update_mask: Optional[field_mask_pb2.FieldMask] = None, - retry: OptionalRetry = gapic_v1.method.DEFAULT, - timeout: Union[float, object] = gapic_v1.method.DEFAULT, - metadata: Sequence[Tuple[str, str]] = (), - ) -> common.SshPublicKey: - r"""Updates an SSH public key and returns the profile - information. This method supports patch semantics. - - .. 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 oslogin_v1 - - def sample_update_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.UpdateSshPublicKeyRequest( - name="name_value", - ) - - # Make the request - response = client.update_ssh_public_key(request=request) - - # Handle the response - print(response) - - Args: - request (Union[google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest, dict]): - The request object. A request message for updating an SSH - public key. - name (str): - Required. The fingerprint of the public key to update. - Public keys are identified by their SHA-256 fingerprint. - The fingerprint of the public key is in format - ``users/{user}/sshPublicKeys/{fingerprint}``. - - This corresponds to the ``name`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - ssh_public_key (google.cloud.oslogin.common.types.SshPublicKey): - Required. The SSH public key and - expiration time. - - This corresponds to the ``ssh_public_key`` field - on the ``request`` instance; if ``request`` is provided, this - should not be set. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Mask to control which fields get - updated. Updates all if not present. - - This corresponds to the ``update_mask`` 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.oslogin.common.types.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - # 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([name, ssh_public_key, update_mask]) - 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.') - - # - Use the request object if provided (there's no risk of modifying the input as - # there are no flattened fields), or create one. - if not isinstance(request, oslogin.UpdateSshPublicKeyRequest): - request = oslogin.UpdateSshPublicKeyRequest(request) - # If we have keyword arguments corresponding to fields on the - # request, apply these. - if name is not None: - request.name = name - if ssh_public_key is not None: - request.ssh_public_key = ssh_public_key - if update_mask is not None: - request.update_mask = update_mask - - # Wrap the RPC method; this adds retry and timeout information, - # and friendly error handling. - rpc = self._transport._wrapped_methods[self._transport.update_ssh_public_key] - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ("name", request.name), - )), - ) - - # Validate the universe domain. - self._validate_universe_domain() - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - def __enter__(self) -> "OsLoginServiceClient": - 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__ = ( - "OsLoginServiceClient", -) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py deleted file mode 100644 index 6d093d3585c4..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 OsLoginServiceTransport -from .grpc import OsLoginServiceGrpcTransport -from .grpc_asyncio import OsLoginServiceGrpcAsyncIOTransport -from .rest import OsLoginServiceRestTransport -from .rest import OsLoginServiceRestInterceptor - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[OsLoginServiceTransport]] -_transport_registry['grpc'] = OsLoginServiceGrpcTransport -_transport_registry['grpc_asyncio'] = OsLoginServiceGrpcAsyncIOTransport -_transport_registry['rest'] = OsLoginServiceRestTransport - -__all__ = ( - 'OsLoginServiceTransport', - 'OsLoginServiceGrpcTransport', - 'OsLoginServiceGrpcAsyncIOTransport', - 'OsLoginServiceRestTransport', - 'OsLoginServiceRestInterceptor', -) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py deleted file mode 100644 index 0e01aac8f2b8..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py +++ /dev/null @@ -1,301 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.oslogin_v1 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.oslogin.common.types import common -from google.cloud.oslogin_v1.types import oslogin -from google.protobuf import empty_pb2 # type: ignore - -DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(gapic_version=package_version.__version__) - - -class OsLoginServiceTransport(abc.ABC): - """Abstract transport class for OsLoginService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud-platform.read-only', - 'https://www.googleapis.com/auth/compute', - 'https://www.googleapis.com/auth/compute.readonly', - ) - - DEFAULT_HOST: str = 'oslogin.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 (default: 'oslogin.googleapis.com'). - 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 - - @property - def host(self): - return self._host - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - self.create_ssh_public_key: gapic_v1.method.wrap_method( - self.create_ssh_public_key, - default_timeout=None, - client_info=client_info, - ), - self.delete_posix_account: gapic_v1.method.wrap_method( - self.delete_posix_account, - 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=10.0, - ), - default_timeout=10.0, - client_info=client_info, - ), - self.delete_ssh_public_key: gapic_v1.method.wrap_method( - self.delete_ssh_public_key, - 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=10.0, - ), - default_timeout=10.0, - client_info=client_info, - ), - self.get_login_profile: gapic_v1.method.wrap_method( - self.get_login_profile, - 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=10.0, - ), - default_timeout=10.0, - client_info=client_info, - ), - self.get_ssh_public_key: gapic_v1.method.wrap_method( - self.get_ssh_public_key, - 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=10.0, - ), - default_timeout=10.0, - client_info=client_info, - ), - self.import_ssh_public_key: gapic_v1.method.wrap_method( - self.import_ssh_public_key, - 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=10.0, - ), - default_timeout=10.0, - client_info=client_info, - ), - self.update_ssh_public_key: gapic_v1.method.wrap_method( - self.update_ssh_public_key, - 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=10.0, - ), - default_timeout=10.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 create_ssh_public_key(self) -> Callable[ - [oslogin.CreateSshPublicKeyRequest], - Union[ - common.SshPublicKey, - Awaitable[common.SshPublicKey] - ]]: - raise NotImplementedError() - - @property - def delete_posix_account(self) -> Callable[ - [oslogin.DeletePosixAccountRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def delete_ssh_public_key(self) -> Callable[ - [oslogin.DeleteSshPublicKeyRequest], - Union[ - empty_pb2.Empty, - Awaitable[empty_pb2.Empty] - ]]: - raise NotImplementedError() - - @property - def get_login_profile(self) -> Callable[ - [oslogin.GetLoginProfileRequest], - Union[ - oslogin.LoginProfile, - Awaitable[oslogin.LoginProfile] - ]]: - raise NotImplementedError() - - @property - def get_ssh_public_key(self) -> Callable[ - [oslogin.GetSshPublicKeyRequest], - Union[ - common.SshPublicKey, - Awaitable[common.SshPublicKey] - ]]: - raise NotImplementedError() - - @property - def import_ssh_public_key(self) -> Callable[ - [oslogin.ImportSshPublicKeyRequest], - Union[ - oslogin.ImportSshPublicKeyResponse, - Awaitable[oslogin.ImportSshPublicKeyResponse] - ]]: - raise NotImplementedError() - - @property - def update_ssh_public_key(self) -> Callable[ - [oslogin.UpdateSshPublicKeyRequest], - Union[ - common.SshPublicKey, - Awaitable[common.SshPublicKey] - ]]: - raise NotImplementedError() - - @property - def kind(self) -> str: - raise NotImplementedError() - - -__all__ = ( - 'OsLoginServiceTransport', -) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py deleted file mode 100644 index c819bd20a0a0..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py +++ /dev/null @@ -1,436 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.oslogin.common.types import common -from google.cloud.oslogin_v1.types import oslogin -from google.protobuf import empty_pb2 # type: ignore -from .base import OsLoginServiceTransport, DEFAULT_CLIENT_INFO - - -class OsLoginServiceGrpcTransport(OsLoginServiceTransport): - """gRPC backend transport for OsLoginService. - - Cloud OS Login API - - The Cloud OS Login API allows you to manage users and their - associated SSH public keys for logging into virtual machines on - Google Cloud Platform. - - 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 = 'oslogin.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[Union[grpc.Channel, Callable[..., 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 (default: 'oslogin.googleapis.com'). - 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 a ``channel`` instance 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 a ``channel`` instance is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if a ``channel`` instance is provided. - channel (Optional[Union[grpc.Channel, Callable[..., grpc.Channel]]]): - A ``Channel`` instance through which to make calls, or a Callable - that constructs and returns one. If set to None, ``self.create_channel`` - is used to create the channel. If a Callable is given, it will be called - with the same arguments as used in ``self.create_channel``. - 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 a ``channel`` instance 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 a ``channel`` instance 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 isinstance(channel, grpc.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: - # initialize with the provided callable or the default channel - channel_init = channel or type(self).create_channel - self._grpc_channel = channel_init( - 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 = 'oslogin.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 create_ssh_public_key(self) -> Callable[ - [oslogin.CreateSshPublicKeyRequest], - common.SshPublicKey]: - r"""Return a callable for the create ssh public key method over gRPC. - - Create an SSH public key - - Returns: - Callable[[~.CreateSshPublicKeyRequest], - ~.SshPublicKey]: - 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 'create_ssh_public_key' not in self._stubs: - self._stubs['create_ssh_public_key'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/CreateSshPublicKey', - request_serializer=oslogin.CreateSshPublicKeyRequest.serialize, - response_deserializer=common.SshPublicKey.deserialize, - ) - return self._stubs['create_ssh_public_key'] - - @property - def delete_posix_account(self) -> Callable[ - [oslogin.DeletePosixAccountRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete posix account method over gRPC. - - Deletes a POSIX account. - - Returns: - Callable[[~.DeletePosixAccountRequest], - ~.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_posix_account' not in self._stubs: - self._stubs['delete_posix_account'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/DeletePosixAccount', - request_serializer=oslogin.DeletePosixAccountRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_posix_account'] - - @property - def delete_ssh_public_key(self) -> Callable[ - [oslogin.DeleteSshPublicKeyRequest], - empty_pb2.Empty]: - r"""Return a callable for the delete ssh public key method over gRPC. - - Deletes an SSH public key. - - Returns: - Callable[[~.DeleteSshPublicKeyRequest], - ~.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_ssh_public_key' not in self._stubs: - self._stubs['delete_ssh_public_key'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/DeleteSshPublicKey', - request_serializer=oslogin.DeleteSshPublicKeyRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_ssh_public_key'] - - @property - def get_login_profile(self) -> Callable[ - [oslogin.GetLoginProfileRequest], - oslogin.LoginProfile]: - r"""Return a callable for the get login profile method over gRPC. - - Retrieves the profile information used for logging in - to a virtual machine on Google Compute Engine. - - Returns: - Callable[[~.GetLoginProfileRequest], - ~.LoginProfile]: - 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_login_profile' not in self._stubs: - self._stubs['get_login_profile'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/GetLoginProfile', - request_serializer=oslogin.GetLoginProfileRequest.serialize, - response_deserializer=oslogin.LoginProfile.deserialize, - ) - return self._stubs['get_login_profile'] - - @property - def get_ssh_public_key(self) -> Callable[ - [oslogin.GetSshPublicKeyRequest], - common.SshPublicKey]: - r"""Return a callable for the get ssh public key method over gRPC. - - Retrieves an SSH public key. - - Returns: - Callable[[~.GetSshPublicKeyRequest], - ~.SshPublicKey]: - 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_ssh_public_key' not in self._stubs: - self._stubs['get_ssh_public_key'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/GetSshPublicKey', - request_serializer=oslogin.GetSshPublicKeyRequest.serialize, - response_deserializer=common.SshPublicKey.deserialize, - ) - return self._stubs['get_ssh_public_key'] - - @property - def import_ssh_public_key(self) -> Callable[ - [oslogin.ImportSshPublicKeyRequest], - oslogin.ImportSshPublicKeyResponse]: - r"""Return a callable for the import ssh public key method over gRPC. - - Adds an SSH public key and returns the profile - information. Default POSIX account information is set - when no username and UID exist as part of the login - profile. - - Returns: - Callable[[~.ImportSshPublicKeyRequest], - ~.ImportSshPublicKeyResponse]: - 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 'import_ssh_public_key' not in self._stubs: - self._stubs['import_ssh_public_key'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/ImportSshPublicKey', - request_serializer=oslogin.ImportSshPublicKeyRequest.serialize, - response_deserializer=oslogin.ImportSshPublicKeyResponse.deserialize, - ) - return self._stubs['import_ssh_public_key'] - - @property - def update_ssh_public_key(self) -> Callable[ - [oslogin.UpdateSshPublicKeyRequest], - common.SshPublicKey]: - r"""Return a callable for the update ssh public key method over gRPC. - - Updates an SSH public key and returns the profile - information. This method supports patch semantics. - - Returns: - Callable[[~.UpdateSshPublicKeyRequest], - ~.SshPublicKey]: - 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_ssh_public_key' not in self._stubs: - self._stubs['update_ssh_public_key'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/UpdateSshPublicKey', - request_serializer=oslogin.UpdateSshPublicKeyRequest.serialize, - response_deserializer=common.SshPublicKey.deserialize, - ) - return self._stubs['update_ssh_public_key'] - - def close(self): - self.grpc_channel.close() - - @property - def kind(self) -> str: - return "grpc" - - -__all__ = ( - 'OsLoginServiceGrpcTransport', -) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py deleted file mode 100644 index 28c403c1b21e..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,536 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.api_core import exceptions as core_exceptions -from google.api_core import retry_async as retries -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.oslogin.common.types import common -from google.cloud.oslogin_v1.types import oslogin -from google.protobuf import empty_pb2 # type: ignore -from .base import OsLoginServiceTransport, DEFAULT_CLIENT_INFO -from .grpc import OsLoginServiceGrpcTransport - - -class OsLoginServiceGrpcAsyncIOTransport(OsLoginServiceTransport): - """gRPC AsyncIO backend transport for OsLoginService. - - Cloud OS Login API - - The Cloud OS Login API allows you to manage users and their - associated SSH public keys for logging into virtual machines on - Google Cloud Platform. - - 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 = 'oslogin.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`. - 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 = 'oslogin.googleapis.com', - credentials: Optional[ga_credentials.Credentials] = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: Optional[Union[aio.Channel, Callable[..., 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 (default: 'oslogin.googleapis.com'). - 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 a ``channel`` instance 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 a ``channel`` instance 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[Union[aio.Channel, Callable[..., aio.Channel]]]): - A ``Channel`` instance through which to make calls, or a Callable - that constructs and returns one. If set to None, ``self.create_channel`` - is used to create the channel. If a Callable is given, it will be called - with the same arguments as used in ``self.create_channel``. - 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 a ``channel`` instance 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 a ``channel`` instance 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 isinstance(channel, aio.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: - # initialize with the provided callable or the default channel - channel_init = channel or type(self).create_channel - self._grpc_channel = channel_init( - 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 create_ssh_public_key(self) -> Callable[ - [oslogin.CreateSshPublicKeyRequest], - Awaitable[common.SshPublicKey]]: - r"""Return a callable for the create ssh public key method over gRPC. - - Create an SSH public key - - Returns: - Callable[[~.CreateSshPublicKeyRequest], - Awaitable[~.SshPublicKey]]: - 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 'create_ssh_public_key' not in self._stubs: - self._stubs['create_ssh_public_key'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/CreateSshPublicKey', - request_serializer=oslogin.CreateSshPublicKeyRequest.serialize, - response_deserializer=common.SshPublicKey.deserialize, - ) - return self._stubs['create_ssh_public_key'] - - @property - def delete_posix_account(self) -> Callable[ - [oslogin.DeletePosixAccountRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete posix account method over gRPC. - - Deletes a POSIX account. - - Returns: - Callable[[~.DeletePosixAccountRequest], - 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_posix_account' not in self._stubs: - self._stubs['delete_posix_account'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/DeletePosixAccount', - request_serializer=oslogin.DeletePosixAccountRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_posix_account'] - - @property - def delete_ssh_public_key(self) -> Callable[ - [oslogin.DeleteSshPublicKeyRequest], - Awaitable[empty_pb2.Empty]]: - r"""Return a callable for the delete ssh public key method over gRPC. - - Deletes an SSH public key. - - Returns: - Callable[[~.DeleteSshPublicKeyRequest], - 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_ssh_public_key' not in self._stubs: - self._stubs['delete_ssh_public_key'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/DeleteSshPublicKey', - request_serializer=oslogin.DeleteSshPublicKeyRequest.serialize, - response_deserializer=empty_pb2.Empty.FromString, - ) - return self._stubs['delete_ssh_public_key'] - - @property - def get_login_profile(self) -> Callable[ - [oslogin.GetLoginProfileRequest], - Awaitable[oslogin.LoginProfile]]: - r"""Return a callable for the get login profile method over gRPC. - - Retrieves the profile information used for logging in - to a virtual machine on Google Compute Engine. - - Returns: - Callable[[~.GetLoginProfileRequest], - Awaitable[~.LoginProfile]]: - 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_login_profile' not in self._stubs: - self._stubs['get_login_profile'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/GetLoginProfile', - request_serializer=oslogin.GetLoginProfileRequest.serialize, - response_deserializer=oslogin.LoginProfile.deserialize, - ) - return self._stubs['get_login_profile'] - - @property - def get_ssh_public_key(self) -> Callable[ - [oslogin.GetSshPublicKeyRequest], - Awaitable[common.SshPublicKey]]: - r"""Return a callable for the get ssh public key method over gRPC. - - Retrieves an SSH public key. - - Returns: - Callable[[~.GetSshPublicKeyRequest], - Awaitable[~.SshPublicKey]]: - 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_ssh_public_key' not in self._stubs: - self._stubs['get_ssh_public_key'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/GetSshPublicKey', - request_serializer=oslogin.GetSshPublicKeyRequest.serialize, - response_deserializer=common.SshPublicKey.deserialize, - ) - return self._stubs['get_ssh_public_key'] - - @property - def import_ssh_public_key(self) -> Callable[ - [oslogin.ImportSshPublicKeyRequest], - Awaitable[oslogin.ImportSshPublicKeyResponse]]: - r"""Return a callable for the import ssh public key method over gRPC. - - Adds an SSH public key and returns the profile - information. Default POSIX account information is set - when no username and UID exist as part of the login - profile. - - Returns: - Callable[[~.ImportSshPublicKeyRequest], - Awaitable[~.ImportSshPublicKeyResponse]]: - 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 'import_ssh_public_key' not in self._stubs: - self._stubs['import_ssh_public_key'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/ImportSshPublicKey', - request_serializer=oslogin.ImportSshPublicKeyRequest.serialize, - response_deserializer=oslogin.ImportSshPublicKeyResponse.deserialize, - ) - return self._stubs['import_ssh_public_key'] - - @property - def update_ssh_public_key(self) -> Callable[ - [oslogin.UpdateSshPublicKeyRequest], - Awaitable[common.SshPublicKey]]: - r"""Return a callable for the update ssh public key method over gRPC. - - Updates an SSH public key and returns the profile - information. This method supports patch semantics. - - Returns: - Callable[[~.UpdateSshPublicKeyRequest], - Awaitable[~.SshPublicKey]]: - 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_ssh_public_key' not in self._stubs: - self._stubs['update_ssh_public_key'] = self.grpc_channel.unary_unary( - '/google.cloud.oslogin.v1.OsLoginService/UpdateSshPublicKey', - request_serializer=oslogin.UpdateSshPublicKeyRequest.serialize, - response_deserializer=common.SshPublicKey.deserialize, - ) - return self._stubs['update_ssh_public_key'] - - def _prep_wrapped_messages(self, client_info): - """ Precompute the wrapped methods, overriding the base class method to use async wrappers.""" - self._wrapped_methods = { - self.create_ssh_public_key: gapic_v1.method_async.wrap_method( - self.create_ssh_public_key, - default_timeout=None, - client_info=client_info, - ), - self.delete_posix_account: gapic_v1.method_async.wrap_method( - self.delete_posix_account, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=client_info, - ), - self.delete_ssh_public_key: gapic_v1.method_async.wrap_method( - self.delete_ssh_public_key, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=client_info, - ), - self.get_login_profile: gapic_v1.method_async.wrap_method( - self.get_login_profile, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=client_info, - ), - self.get_ssh_public_key: gapic_v1.method_async.wrap_method( - self.get_ssh_public_key, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=client_info, - ), - self.import_ssh_public_key: gapic_v1.method_async.wrap_method( - self.import_ssh_public_key, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=client_info, - ), - self.update_ssh_public_key: gapic_v1.method_async.wrap_method( - self.update_ssh_public_key, - default_retry=retries.AsyncRetry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - core_exceptions.DeadlineExceeded, - core_exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=client_info, - ), - } - - def close(self): - return self.grpc_channel.close() - - -__all__ = ( - 'OsLoginServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/rest.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/rest.py deleted file mode 100644 index e2db6459b73c..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/services/os_login_service/transports/rest.py +++ /dev/null @@ -1,941 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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, None] -except AttributeError: # pragma: NO COVER - OptionalRetry = Union[retries.Retry, object, None] # type: ignore - - -from google.cloud.oslogin.common.types import common -from google.cloud.oslogin_v1.types import oslogin -from google.protobuf import empty_pb2 # type: ignore - -from .base import OsLoginServiceTransport, 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 OsLoginServiceRestInterceptor: - """Interceptor for OsLoginService. - - 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 OsLoginServiceRestTransport. - - .. code-block:: python - class MyCustomOsLoginServiceInterceptor(OsLoginServiceRestInterceptor): - def pre_create_ssh_public_key(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_create_ssh_public_key(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_delete_posix_account(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def pre_delete_ssh_public_key(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def pre_get_login_profile(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_login_profile(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_get_ssh_public_key(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_get_ssh_public_key(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_import_ssh_public_key(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_import_ssh_public_key(self, response): - logging.log(f"Received response: {response}") - return response - - def pre_update_ssh_public_key(self, request, metadata): - logging.log(f"Received request: {request}") - return request, metadata - - def post_update_ssh_public_key(self, response): - logging.log(f"Received response: {response}") - return response - - transport = OsLoginServiceRestTransport(interceptor=MyCustomOsLoginServiceInterceptor()) - client = OsLoginServiceClient(transport=transport) - - - """ - def pre_create_ssh_public_key(self, request: oslogin.CreateSshPublicKeyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.CreateSshPublicKeyRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for create_ssh_public_key - - Override in a subclass to manipulate the request or metadata - before they are sent to the OsLoginService server. - """ - return request, metadata - - def post_create_ssh_public_key(self, response: common.SshPublicKey) -> common.SshPublicKey: - """Post-rpc interceptor for create_ssh_public_key - - Override in a subclass to manipulate the response - after it is returned by the OsLoginService server but before - it is returned to user code. - """ - return response - def pre_delete_posix_account(self, request: oslogin.DeletePosixAccountRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.DeletePosixAccountRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for delete_posix_account - - Override in a subclass to manipulate the request or metadata - before they are sent to the OsLoginService server. - """ - return request, metadata - - def pre_delete_ssh_public_key(self, request: oslogin.DeleteSshPublicKeyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.DeleteSshPublicKeyRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for delete_ssh_public_key - - Override in a subclass to manipulate the request or metadata - before they are sent to the OsLoginService server. - """ - return request, metadata - - def pre_get_login_profile(self, request: oslogin.GetLoginProfileRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.GetLoginProfileRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_login_profile - - Override in a subclass to manipulate the request or metadata - before they are sent to the OsLoginService server. - """ - return request, metadata - - def post_get_login_profile(self, response: oslogin.LoginProfile) -> oslogin.LoginProfile: - """Post-rpc interceptor for get_login_profile - - Override in a subclass to manipulate the response - after it is returned by the OsLoginService server but before - it is returned to user code. - """ - return response - def pre_get_ssh_public_key(self, request: oslogin.GetSshPublicKeyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.GetSshPublicKeyRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for get_ssh_public_key - - Override in a subclass to manipulate the request or metadata - before they are sent to the OsLoginService server. - """ - return request, metadata - - def post_get_ssh_public_key(self, response: common.SshPublicKey) -> common.SshPublicKey: - """Post-rpc interceptor for get_ssh_public_key - - Override in a subclass to manipulate the response - after it is returned by the OsLoginService server but before - it is returned to user code. - """ - return response - def pre_import_ssh_public_key(self, request: oslogin.ImportSshPublicKeyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.ImportSshPublicKeyRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for import_ssh_public_key - - Override in a subclass to manipulate the request or metadata - before they are sent to the OsLoginService server. - """ - return request, metadata - - def post_import_ssh_public_key(self, response: oslogin.ImportSshPublicKeyResponse) -> oslogin.ImportSshPublicKeyResponse: - """Post-rpc interceptor for import_ssh_public_key - - Override in a subclass to manipulate the response - after it is returned by the OsLoginService server but before - it is returned to user code. - """ - return response - def pre_update_ssh_public_key(self, request: oslogin.UpdateSshPublicKeyRequest, metadata: Sequence[Tuple[str, str]]) -> Tuple[oslogin.UpdateSshPublicKeyRequest, Sequence[Tuple[str, str]]]: - """Pre-rpc interceptor for update_ssh_public_key - - Override in a subclass to manipulate the request or metadata - before they are sent to the OsLoginService server. - """ - return request, metadata - - def post_update_ssh_public_key(self, response: common.SshPublicKey) -> common.SshPublicKey: - """Post-rpc interceptor for update_ssh_public_key - - Override in a subclass to manipulate the response - after it is returned by the OsLoginService server but before - it is returned to user code. - """ - return response - - -@dataclasses.dataclass -class OsLoginServiceRestStub: - _session: AuthorizedSession - _host: str - _interceptor: OsLoginServiceRestInterceptor - - -class OsLoginServiceRestTransport(OsLoginServiceTransport): - """REST backend transport for OsLoginService. - - Cloud OS Login API - - The Cloud OS Login API allows you to manage users and their - associated SSH public keys for logging into virtual machines on - Google Cloud Platform. - - 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 = 'oslogin.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[OsLoginServiceRestInterceptor] = None, - api_audience: Optional[str] = None, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): - The hostname to connect to (default: 'oslogin.googleapis.com'). - 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 OsLoginServiceRestInterceptor() - self._prep_wrapped_messages(client_info) - - class _CreateSshPublicKey(OsLoginServiceRestStub): - def __hash__(self): - return hash("CreateSshPublicKey") - - __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: oslogin.CreateSshPublicKeyRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> common.SshPublicKey: - r"""Call the create ssh public key method over HTTP. - - Args: - request (~.oslogin.CreateSshPublicKeyRequest): - The request object. A request message for creating an SSH - public key. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be 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: - ~.common.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{parent=users/*}/sshPublicKeys', - 'body': 'ssh_public_key', - }, - ] - request, metadata = self._interceptor.pre_create_ssh_public_key(request, metadata) - pb_request = oslogin.CreateSshPublicKeyRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - 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'], - 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 = common.SshPublicKey() - pb_resp = common.SshPublicKey.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_create_ssh_public_key(resp) - return resp - - class _DeletePosixAccount(OsLoginServiceRestStub): - def __hash__(self): - return hash("DeletePosixAccount") - - __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: oslogin.DeletePosixAccountRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ): - r"""Call the delete posix account method over HTTP. - - Args: - request (~.oslogin.DeletePosixAccountRequest): - The request object. A request message for deleting a - POSIX account entry. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be 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': '/v1/{name=users/*/projects/*}', - }, - ] - request, metadata = self._interceptor.pre_delete_posix_account(request, metadata) - pb_request = oslogin.DeletePosixAccountRequest.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'], - 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 _DeleteSshPublicKey(OsLoginServiceRestStub): - def __hash__(self): - return hash("DeleteSshPublicKey") - - __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: oslogin.DeleteSshPublicKeyRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ): - r"""Call the delete ssh public key method over HTTP. - - Args: - request (~.oslogin.DeleteSshPublicKeyRequest): - The request object. A request message for deleting an SSH - public key. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be 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': '/v1/{name=users/*/sshPublicKeys/*}', - }, - ] - request, metadata = self._interceptor.pre_delete_ssh_public_key(request, metadata) - pb_request = oslogin.DeleteSshPublicKeyRequest.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'], - 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 _GetLoginProfile(OsLoginServiceRestStub): - def __hash__(self): - return hash("GetLoginProfile") - - __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: oslogin.GetLoginProfileRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> oslogin.LoginProfile: - r"""Call the get login profile method over HTTP. - - Args: - request (~.oslogin.GetLoginProfileRequest): - The request object. A request message for retrieving the - login profile information for a user. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be 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: - ~.oslogin.LoginProfile: - The user profile information used for - logging in to a virtual machine on - Google Compute Engine. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{name=users/*}/loginProfile', - }, - ] - request, metadata = self._interceptor.pre_get_login_profile(request, metadata) - pb_request = oslogin.GetLoginProfileRequest.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'], - 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 = oslogin.LoginProfile() - pb_resp = oslogin.LoginProfile.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_login_profile(resp) - return resp - - class _GetSshPublicKey(OsLoginServiceRestStub): - def __hash__(self): - return hash("GetSshPublicKey") - - __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: oslogin.GetSshPublicKeyRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> common.SshPublicKey: - r"""Call the get ssh public key method over HTTP. - - Args: - request (~.oslogin.GetSshPublicKeyRequest): - The request object. A request message for retrieving an - SSH public key. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be 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: - ~.common.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'get', - 'uri': '/v1/{name=users/*/sshPublicKeys/*}', - }, - ] - request, metadata = self._interceptor.pre_get_ssh_public_key(request, metadata) - pb_request = oslogin.GetSshPublicKeyRequest.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'], - 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 = common.SshPublicKey() - pb_resp = common.SshPublicKey.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_get_ssh_public_key(resp) - return resp - - class _ImportSshPublicKey(OsLoginServiceRestStub): - def __hash__(self): - return hash("ImportSshPublicKey") - - __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: oslogin.ImportSshPublicKeyRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> oslogin.ImportSshPublicKeyResponse: - r"""Call the import ssh public key method over HTTP. - - Args: - request (~.oslogin.ImportSshPublicKeyRequest): - The request object. A request message for importing an - SSH public key. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be 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: - ~.oslogin.ImportSshPublicKeyResponse: - A response message for importing an - SSH public key. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'post', - 'uri': '/v1/{parent=users/*}:importSshPublicKey', - 'body': 'ssh_public_key', - }, - ] - request, metadata = self._interceptor.pre_import_ssh_public_key(request, metadata) - pb_request = oslogin.ImportSshPublicKeyRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - 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'], - 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 = oslogin.ImportSshPublicKeyResponse() - pb_resp = oslogin.ImportSshPublicKeyResponse.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_import_ssh_public_key(resp) - return resp - - class _UpdateSshPublicKey(OsLoginServiceRestStub): - def __hash__(self): - return hash("UpdateSshPublicKey") - - __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: oslogin.UpdateSshPublicKeyRequest, *, - retry: OptionalRetry=gapic_v1.method.DEFAULT, - timeout: Optional[float]=None, - metadata: Sequence[Tuple[str, str]]=(), - ) -> common.SshPublicKey: - r"""Call the update ssh public key method over HTTP. - - Args: - request (~.oslogin.UpdateSshPublicKeyRequest): - The request object. A request message for updating an SSH - public key. - retry (google.api_core.retry.Retry): Designation of what errors, if any, - should be 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: - ~.common.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - - http_options: List[Dict[str, str]] = [{ - 'method': 'patch', - 'uri': '/v1/{name=users/*/sshPublicKeys/*}', - 'body': 'ssh_public_key', - }, - ] - request, metadata = self._interceptor.pre_update_ssh_public_key(request, metadata) - pb_request = oslogin.UpdateSshPublicKeyRequest.pb(request) - transcoded_request = path_template.transcode(http_options, pb_request) - - # Jsonify the request body - - body = json_format.MessageToJson( - transcoded_request['body'], - 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'], - 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 = common.SshPublicKey() - pb_resp = common.SshPublicKey.pb(resp) - - json_format.Parse(response.content, pb_resp, ignore_unknown_fields=True) - resp = self._interceptor.post_update_ssh_public_key(resp) - return resp - - @property - def create_ssh_public_key(self) -> Callable[ - [oslogin.CreateSshPublicKeyRequest], - common.SshPublicKey]: - # 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._CreateSshPublicKey(self._session, self._host, self._interceptor) # type: ignore - - @property - def delete_posix_account(self) -> Callable[ - [oslogin.DeletePosixAccountRequest], - 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._DeletePosixAccount(self._session, self._host, self._interceptor) # type: ignore - - @property - def delete_ssh_public_key(self) -> Callable[ - [oslogin.DeleteSshPublicKeyRequest], - 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._DeleteSshPublicKey(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_login_profile(self) -> Callable[ - [oslogin.GetLoginProfileRequest], - oslogin.LoginProfile]: - # 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._GetLoginProfile(self._session, self._host, self._interceptor) # type: ignore - - @property - def get_ssh_public_key(self) -> Callable[ - [oslogin.GetSshPublicKeyRequest], - common.SshPublicKey]: - # 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._GetSshPublicKey(self._session, self._host, self._interceptor) # type: ignore - - @property - def import_ssh_public_key(self) -> Callable[ - [oslogin.ImportSshPublicKeyRequest], - oslogin.ImportSshPublicKeyResponse]: - # 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._ImportSshPublicKey(self._session, self._host, self._interceptor) # type: ignore - - @property - def update_ssh_public_key(self) -> Callable[ - [oslogin.UpdateSshPublicKeyRequest], - common.SshPublicKey]: - # 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._UpdateSshPublicKey(self._session, self._host, self._interceptor) # type: ignore - - @property - def kind(self) -> str: - return "rest" - - def close(self): - self._session.close() - - -__all__=( - 'OsLoginServiceRestTransport', -) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/__init__.py deleted file mode 100644 index 331a54120882..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 .oslogin import ( - CreateSshPublicKeyRequest, - DeletePosixAccountRequest, - DeleteSshPublicKeyRequest, - GetLoginProfileRequest, - GetSshPublicKeyRequest, - ImportSshPublicKeyRequest, - ImportSshPublicKeyResponse, - LoginProfile, - UpdateSshPublicKeyRequest, -) - -__all__ = ( - 'CreateSshPublicKeyRequest', - 'DeletePosixAccountRequest', - 'DeleteSshPublicKeyRequest', - 'GetLoginProfileRequest', - 'GetSshPublicKeyRequest', - 'ImportSshPublicKeyRequest', - 'ImportSshPublicKeyResponse', - 'LoginProfile', - 'UpdateSshPublicKeyRequest', -) diff --git a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/oslogin.py b/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/oslogin.py deleted file mode 100644 index 0450289b7482..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/google/cloud/oslogin_v1/types/oslogin.py +++ /dev/null @@ -1,271 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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.oslogin.common.types import common -from google.protobuf import field_mask_pb2 # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.oslogin.v1', - manifest={ - 'LoginProfile', - 'CreateSshPublicKeyRequest', - 'DeletePosixAccountRequest', - 'DeleteSshPublicKeyRequest', - 'GetLoginProfileRequest', - 'GetSshPublicKeyRequest', - 'ImportSshPublicKeyRequest', - 'ImportSshPublicKeyResponse', - 'UpdateSshPublicKeyRequest', - }, -) - - -class LoginProfile(proto.Message): - r"""The user profile information used for logging in to a virtual - machine on Google Compute Engine. - - Attributes: - name (str): - Required. A unique user ID. - posix_accounts (MutableSequence[google.cloud.oslogin.common.types.PosixAccount]): - The list of POSIX accounts associated with - the user. - ssh_public_keys (MutableMapping[str, google.cloud.oslogin.common.types.SshPublicKey]): - A map from SSH public key fingerprint to the - associated key object. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - posix_accounts: MutableSequence[common.PosixAccount] = proto.RepeatedField( - proto.MESSAGE, - number=2, - message=common.PosixAccount, - ) - ssh_public_keys: MutableMapping[str, common.SshPublicKey] = proto.MapField( - proto.STRING, - proto.MESSAGE, - number=3, - message=common.SshPublicKey, - ) - - -class CreateSshPublicKeyRequest(proto.Message): - r"""A request message for creating an SSH public key. - - Attributes: - parent (str): - Required. The unique ID for the user in format - ``users/{user}``. - ssh_public_key (google.cloud.oslogin.common.types.SshPublicKey): - Required. The SSH public key and expiration - time. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - ssh_public_key: common.SshPublicKey = proto.Field( - proto.MESSAGE, - number=2, - message=common.SshPublicKey, - ) - - -class DeletePosixAccountRequest(proto.Message): - r"""A request message for deleting a POSIX account entry. - - Attributes: - name (str): - Required. A reference to the POSIX account to update. POSIX - accounts are identified by the project ID they are - associated with. A reference to the POSIX account is in - format ``users/{user}/projects/{project}``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class DeleteSshPublicKeyRequest(proto.Message): - r"""A request message for deleting an SSH public key. - - Attributes: - name (str): - Required. The fingerprint of the public key to update. - Public keys are identified by their SHA-256 fingerprint. The - fingerprint of the public key is in format - ``users/{user}/sshPublicKeys/{fingerprint}``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class GetLoginProfileRequest(proto.Message): - r"""A request message for retrieving the login profile - information for a user. - - Attributes: - name (str): - Required. The unique ID for the user in format - ``users/{user}``. - project_id (str): - The project ID of the Google Cloud Platform - project. - system_id (str): - A system ID for filtering the results of the - request. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - project_id: str = proto.Field( - proto.STRING, - number=2, - ) - system_id: str = proto.Field( - proto.STRING, - number=3, - ) - - -class GetSshPublicKeyRequest(proto.Message): - r"""A request message for retrieving an SSH public key. - - Attributes: - name (str): - Required. The fingerprint of the public key to retrieve. - Public keys are identified by their SHA-256 fingerprint. The - fingerprint of the public key is in format - ``users/{user}/sshPublicKeys/{fingerprint}``. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - - -class ImportSshPublicKeyRequest(proto.Message): - r"""A request message for importing an SSH public key. - - Attributes: - parent (str): - Required. The unique ID for the user in format - ``users/{user}``. - ssh_public_key (google.cloud.oslogin.common.types.SshPublicKey): - Optional. The SSH public key and expiration - time. - project_id (str): - The project ID of the Google Cloud Platform - project. - regions (MutableSequence[str]): - Optional. The regions to which to assert that - the key was written. If unspecified, defaults to - all regions. Regions are listed at - https://cloud.google.com/about/locations#region. - """ - - parent: str = proto.Field( - proto.STRING, - number=1, - ) - ssh_public_key: common.SshPublicKey = proto.Field( - proto.MESSAGE, - number=2, - message=common.SshPublicKey, - ) - project_id: str = proto.Field( - proto.STRING, - number=3, - ) - regions: MutableSequence[str] = proto.RepeatedField( - proto.STRING, - number=5, - ) - - -class ImportSshPublicKeyResponse(proto.Message): - r"""A response message for importing an SSH public key. - - Attributes: - login_profile (google.cloud.oslogin_v1.types.LoginProfile): - The login profile information for the user. - details (str): - Detailed information about import results. - """ - - login_profile: 'LoginProfile' = proto.Field( - proto.MESSAGE, - number=1, - message='LoginProfile', - ) - details: str = proto.Field( - proto.STRING, - number=2, - ) - - -class UpdateSshPublicKeyRequest(proto.Message): - r"""A request message for updating an SSH public key. - - Attributes: - name (str): - Required. The fingerprint of the public key to update. - Public keys are identified by their SHA-256 fingerprint. The - fingerprint of the public key is in format - ``users/{user}/sshPublicKeys/{fingerprint}``. - ssh_public_key (google.cloud.oslogin.common.types.SshPublicKey): - Required. The SSH public key and expiration - time. - update_mask (google.protobuf.field_mask_pb2.FieldMask): - Mask to control which fields get updated. - Updates all if not present. - """ - - name: str = proto.Field( - proto.STRING, - number=1, - ) - ssh_public_key: common.SshPublicKey = proto.Field( - proto.MESSAGE, - number=2, - message=common.SshPublicKey, - ) - update_mask: field_mask_pb2.FieldMask = proto.Field( - proto.MESSAGE, - number=3, - message=field_mask_pb2.FieldMask, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/google-cloud-os-login/v1/mypy.ini b/owl-bot-staging/google-cloud-os-login/v1/mypy.ini deleted file mode 100644 index 574c5aed394b..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.7 -namespace_packages = True diff --git a/owl-bot-staging/google-cloud-os-login/v1/noxfile.py b/owl-bot-staging/google-cloud-os-login/v1/noxfile.py deleted file mode 100644 index 77d33bf87156..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/noxfile.py +++ /dev/null @@ -1,253 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 re -import shutil -import subprocess -import sys - - -import nox # type: ignore - -ALL_PYTHON = [ - "3.7", - "3.8", - "3.9", - "3.10", - "3.11", - "3.12" -] - -CURRENT_DIRECTORY = pathlib.Path(__file__).parent.absolute() - -LOWER_BOUND_CONSTRAINTS_FILE = CURRENT_DIRECTORY / "constraints.txt" -PACKAGE_NAME = 'google-cloud-os-login' - -BLACK_VERSION = "black==22.3.0" -BLACK_PATHS = ["docs", "google", "tests", "samples", "noxfile.py", "setup.py"] -DEFAULT_PYTHON_VERSION = "3.12" - -nox.sessions = [ - "unit", - "cover", - "mypy", - "check_lower_bounds" - # exclude update_lower_bounds from default - "docs", - "blacken", - "lint", - "prerelease_deps", -] - -@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/oslogin_v1/', - '--cov=tests/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - -@nox.session(python=ALL_PYTHON[-1]) -def prerelease_deps(session): - """Run the unit test suite against pre-release versions of dependencies.""" - - # Install test environment dependencies - session.install('coverage', 'pytest', 'pytest-cov', 'pytest-asyncio', 'asyncmock; python_version < "3.8"') - - # Install the package without dependencies - session.install('-e', '.', '--no-deps') - - # We test the minimum dependency versions using the minimum Python - # version so the lowest python runtime that we test has a corresponding constraints - # file, located at `testing/constraints--.txt`, which contains all of the - # dependencies and extras. - with open( - CURRENT_DIRECTORY - / "testing" - / f"constraints-{ALL_PYTHON[0]}.txt", - encoding="utf-8", - ) as constraints_file: - constraints_text = constraints_file.read() - - # Ignore leading whitespace and comment lines. - constraints_deps = [ - match.group(1) - for match in re.finditer( - r"^\s*(\S+)(?===\S+)", constraints_text, flags=re.MULTILINE - ) - ] - - session.install(*constraints_deps) - - prerel_deps = [ - "googleapis-common-protos", - "google-api-core", - "google-auth", - "grpcio", - "grpcio-status", - "protobuf", - "proto-plus", - ] - - for dep in prerel_deps: - session.install("--pre", "--no-deps", "--upgrade", dep) - - # Remaining dependencies - other_deps = [ - "requests", - ] - session.install(*other_deps) - - # Print out prerelease package versions - - session.run("python", "-c", "import google.api_core; print(google.api_core.__version__)") - session.run("python", "-c", "import google.auth; print(google.auth.__version__)") - session.run("python", "-c", "import grpc; print(grpc.__version__)") - session.run( - "python", "-c", "import google.protobuf; print(google.protobuf.__version__)" - ) - session.run( - "python", "-c", "import proto; print(proto.__version__)" - ) - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/oslogin_v1/', - '--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', - '-p', - '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==7.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, - ) diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_async.py deleted file mode 100644 index d3579bbd7a15..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 CreateSshPublicKey -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_CreateSshPublicKey_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 oslogin_v1 - - -async def sample_create_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.CreateSshPublicKeyRequest( - parent="parent_value", - ) - - # Make the request - response = await client.create_ssh_public_key(request=request) - - # Handle the response - print(response) - -# [END oslogin_v1_generated_OsLoginService_CreateSshPublicKey_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_sync.py deleted file mode 100644 index ee1e2117bf43..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_create_ssh_public_key_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 CreateSshPublicKey -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_CreateSshPublicKey_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 oslogin_v1 - - -def sample_create_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.CreateSshPublicKeyRequest( - parent="parent_value", - ) - - # Make the request - response = client.create_ssh_public_key(request=request) - - # Handle the response - print(response) - -# [END oslogin_v1_generated_OsLoginService_CreateSshPublicKey_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_async.py deleted file mode 100644 index ee50ecc45d35..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_async.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 DeletePosixAccount -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_DeletePosixAccount_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 oslogin_v1 - - -async def sample_delete_posix_account(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.DeletePosixAccountRequest( - name="name_value", - ) - - # Make the request - await client.delete_posix_account(request=request) - - -# [END oslogin_v1_generated_OsLoginService_DeletePosixAccount_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_sync.py deleted file mode 100644 index f21e23eec73c..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_posix_account_sync.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 DeletePosixAccount -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_DeletePosixAccount_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 oslogin_v1 - - -def sample_delete_posix_account(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.DeletePosixAccountRequest( - name="name_value", - ) - - # Make the request - client.delete_posix_account(request=request) - - -# [END oslogin_v1_generated_OsLoginService_DeletePosixAccount_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_async.py deleted file mode 100644 index 82ba6ac0d53b..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_async.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 DeleteSshPublicKey -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_DeleteSshPublicKey_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 oslogin_v1 - - -async def sample_delete_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.DeleteSshPublicKeyRequest( - name="name_value", - ) - - # Make the request - await client.delete_ssh_public_key(request=request) - - -# [END oslogin_v1_generated_OsLoginService_DeleteSshPublicKey_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_sync.py deleted file mode 100644 index 7b127f8dad37..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_delete_ssh_public_key_sync.py +++ /dev/null @@ -1,50 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 DeleteSshPublicKey -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_DeleteSshPublicKey_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 oslogin_v1 - - -def sample_delete_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.DeleteSshPublicKeyRequest( - name="name_value", - ) - - # Make the request - client.delete_ssh_public_key(request=request) - - -# [END oslogin_v1_generated_OsLoginService_DeleteSshPublicKey_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_async.py deleted file mode 100644 index 05b9bc022cc8..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 GetLoginProfile -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_GetLoginProfile_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 oslogin_v1 - - -async def sample_get_login_profile(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.GetLoginProfileRequest( - name="name_value", - ) - - # Make the request - response = await client.get_login_profile(request=request) - - # Handle the response - print(response) - -# [END oslogin_v1_generated_OsLoginService_GetLoginProfile_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_sync.py deleted file mode 100644 index 49db40965d5e..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_login_profile_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 GetLoginProfile -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_GetLoginProfile_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 oslogin_v1 - - -def sample_get_login_profile(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.GetLoginProfileRequest( - name="name_value", - ) - - # Make the request - response = client.get_login_profile(request=request) - - # Handle the response - print(response) - -# [END oslogin_v1_generated_OsLoginService_GetLoginProfile_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_async.py deleted file mode 100644 index fff1105c0c2d..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 GetSshPublicKey -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_GetSshPublicKey_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 oslogin_v1 - - -async def sample_get_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.GetSshPublicKeyRequest( - name="name_value", - ) - - # Make the request - response = await client.get_ssh_public_key(request=request) - - # Handle the response - print(response) - -# [END oslogin_v1_generated_OsLoginService_GetSshPublicKey_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_sync.py deleted file mode 100644 index b20fb7c0849a..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_get_ssh_public_key_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 GetSshPublicKey -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_GetSshPublicKey_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 oslogin_v1 - - -def sample_get_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.GetSshPublicKeyRequest( - name="name_value", - ) - - # Make the request - response = client.get_ssh_public_key(request=request) - - # Handle the response - print(response) - -# [END oslogin_v1_generated_OsLoginService_GetSshPublicKey_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_async.py deleted file mode 100644 index 00e4c918453c..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 ImportSshPublicKey -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_ImportSshPublicKey_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 oslogin_v1 - - -async def sample_import_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.ImportSshPublicKeyRequest( - parent="parent_value", - ) - - # Make the request - response = await client.import_ssh_public_key(request=request) - - # Handle the response - print(response) - -# [END oslogin_v1_generated_OsLoginService_ImportSshPublicKey_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_sync.py deleted file mode 100644 index 7db23783c243..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_import_ssh_public_key_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 ImportSshPublicKey -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_ImportSshPublicKey_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 oslogin_v1 - - -def sample_import_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.ImportSshPublicKeyRequest( - parent="parent_value", - ) - - # Make the request - response = client.import_ssh_public_key(request=request) - - # Handle the response - print(response) - -# [END oslogin_v1_generated_OsLoginService_ImportSshPublicKey_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_async.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_async.py deleted file mode 100644 index a37078b26198..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_async.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 UpdateSshPublicKey -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_UpdateSshPublicKey_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 oslogin_v1 - - -async def sample_update_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceAsyncClient() - - # Initialize request argument(s) - request = oslogin_v1.UpdateSshPublicKeyRequest( - name="name_value", - ) - - # Make the request - response = await client.update_ssh_public_key(request=request) - - # Handle the response - print(response) - -# [END oslogin_v1_generated_OsLoginService_UpdateSshPublicKey_async] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_sync.py b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_sync.py deleted file mode 100644 index c800ff02d601..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/oslogin_v1_generated_os_login_service_update_ssh_public_key_sync.py +++ /dev/null @@ -1,52 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 UpdateSshPublicKey -# 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-os-login - - -# [START oslogin_v1_generated_OsLoginService_UpdateSshPublicKey_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 oslogin_v1 - - -def sample_update_ssh_public_key(): - # Create a client - client = oslogin_v1.OsLoginServiceClient() - - # Initialize request argument(s) - request = oslogin_v1.UpdateSshPublicKeyRequest( - name="name_value", - ) - - # Make the request - response = client.update_ssh_public_key(request=request) - - # Handle the response - print(response) - -# [END oslogin_v1_generated_OsLoginService_UpdateSshPublicKey_sync] diff --git a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/snippet_metadata_google.cloud.oslogin.v1.json b/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/snippet_metadata_google.cloud.oslogin.v1.json deleted file mode 100644 index 92b367f767a3..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/samples/generated_samples/snippet_metadata_google.cloud.oslogin.v1.json +++ /dev/null @@ -1,1170 +0,0 @@ -{ - "clientLibrary": { - "apis": [ - { - "id": "google.cloud.oslogin.v1", - "version": "v1" - } - ], - "language": "PYTHON", - "name": "google-cloud-os-login", - "version": "0.1.0" - }, - "snippets": [ - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", - "shortName": "OsLoginServiceAsyncClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.create_ssh_public_key", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.CreateSshPublicKey", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "CreateSshPublicKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.CreateSshPublicKeyRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "ssh_public_key", - "type": "google.cloud.oslogin.common.types.SshPublicKey" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.oslogin.common.types.SshPublicKey", - "shortName": "create_ssh_public_key" - }, - "description": "Sample for CreateSshPublicKey", - "file": "oslogin_v1_generated_os_login_service_create_ssh_public_key_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_CreateSshPublicKey_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": "oslogin_v1_generated_os_login_service_create_ssh_public_key_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", - "shortName": "OsLoginServiceClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.create_ssh_public_key", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.CreateSshPublicKey", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "CreateSshPublicKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.CreateSshPublicKeyRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "ssh_public_key", - "type": "google.cloud.oslogin.common.types.SshPublicKey" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.oslogin.common.types.SshPublicKey", - "shortName": "create_ssh_public_key" - }, - "description": "Sample for CreateSshPublicKey", - "file": "oslogin_v1_generated_os_login_service_create_ssh_public_key_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_CreateSshPublicKey_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": "oslogin_v1_generated_os_login_service_create_ssh_public_key_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", - "shortName": "OsLoginServiceAsyncClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.delete_posix_account", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.DeletePosixAccount", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "DeletePosixAccount" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.DeletePosixAccountRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_posix_account" - }, - "description": "Sample for DeletePosixAccount", - "file": "oslogin_v1_generated_os_login_service_delete_posix_account_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_DeletePosixAccount_async", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "oslogin_v1_generated_os_login_service_delete_posix_account_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", - "shortName": "OsLoginServiceClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.delete_posix_account", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.DeletePosixAccount", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "DeletePosixAccount" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.DeletePosixAccountRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_posix_account" - }, - "description": "Sample for DeletePosixAccount", - "file": "oslogin_v1_generated_os_login_service_delete_posix_account_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_DeletePosixAccount_sync", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "oslogin_v1_generated_os_login_service_delete_posix_account_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", - "shortName": "OsLoginServiceAsyncClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.delete_ssh_public_key", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.DeleteSshPublicKey", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "DeleteSshPublicKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_ssh_public_key" - }, - "description": "Sample for DeleteSshPublicKey", - "file": "oslogin_v1_generated_os_login_service_delete_ssh_public_key_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_DeleteSshPublicKey_async", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "oslogin_v1_generated_os_login_service_delete_ssh_public_key_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", - "shortName": "OsLoginServiceClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.delete_ssh_public_key", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.DeleteSshPublicKey", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "DeleteSshPublicKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "shortName": "delete_ssh_public_key" - }, - "description": "Sample for DeleteSshPublicKey", - "file": "oslogin_v1_generated_os_login_service_delete_ssh_public_key_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_DeleteSshPublicKey_sync", - "segments": [ - { - "end": 49, - "start": 27, - "type": "FULL" - }, - { - "end": 49, - "start": 27, - "type": "SHORT" - }, - { - "end": 40, - "start": 38, - "type": "CLIENT_INITIALIZATION" - }, - { - "end": 45, - "start": 41, - "type": "REQUEST_INITIALIZATION" - }, - { - "start": 46, - "type": "REQUEST_EXECUTION" - }, - { - "end": 50, - "type": "RESPONSE_HANDLING" - } - ], - "title": "oslogin_v1_generated_os_login_service_delete_ssh_public_key_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", - "shortName": "OsLoginServiceAsyncClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.get_login_profile", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.GetLoginProfile", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "GetLoginProfile" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.GetLoginProfileRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.oslogin_v1.types.LoginProfile", - "shortName": "get_login_profile" - }, - "description": "Sample for GetLoginProfile", - "file": "oslogin_v1_generated_os_login_service_get_login_profile_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_GetLoginProfile_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": "oslogin_v1_generated_os_login_service_get_login_profile_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", - "shortName": "OsLoginServiceClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.get_login_profile", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.GetLoginProfile", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "GetLoginProfile" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.GetLoginProfileRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.oslogin_v1.types.LoginProfile", - "shortName": "get_login_profile" - }, - "description": "Sample for GetLoginProfile", - "file": "oslogin_v1_generated_os_login_service_get_login_profile_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_GetLoginProfile_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": "oslogin_v1_generated_os_login_service_get_login_profile_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", - "shortName": "OsLoginServiceAsyncClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.get_ssh_public_key", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.GetSshPublicKey", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "GetSshPublicKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.GetSshPublicKeyRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.oslogin.common.types.SshPublicKey", - "shortName": "get_ssh_public_key" - }, - "description": "Sample for GetSshPublicKey", - "file": "oslogin_v1_generated_os_login_service_get_ssh_public_key_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_GetSshPublicKey_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": "oslogin_v1_generated_os_login_service_get_ssh_public_key_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", - "shortName": "OsLoginServiceClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.get_ssh_public_key", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.GetSshPublicKey", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "GetSshPublicKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.GetSshPublicKeyRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.oslogin.common.types.SshPublicKey", - "shortName": "get_ssh_public_key" - }, - "description": "Sample for GetSshPublicKey", - "file": "oslogin_v1_generated_os_login_service_get_ssh_public_key_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_GetSshPublicKey_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": "oslogin_v1_generated_os_login_service_get_ssh_public_key_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", - "shortName": "OsLoginServiceAsyncClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.import_ssh_public_key", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.ImportSshPublicKey", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "ImportSshPublicKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "ssh_public_key", - "type": "google.cloud.oslogin.common.types.SshPublicKey" - }, - { - "name": "project_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.oslogin_v1.types.ImportSshPublicKeyResponse", - "shortName": "import_ssh_public_key" - }, - "description": "Sample for ImportSshPublicKey", - "file": "oslogin_v1_generated_os_login_service_import_ssh_public_key_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_ImportSshPublicKey_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": "oslogin_v1_generated_os_login_service_import_ssh_public_key_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", - "shortName": "OsLoginServiceClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.import_ssh_public_key", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.ImportSshPublicKey", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "ImportSshPublicKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest" - }, - { - "name": "parent", - "type": "str" - }, - { - "name": "ssh_public_key", - "type": "google.cloud.oslogin.common.types.SshPublicKey" - }, - { - "name": "project_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.oslogin_v1.types.ImportSshPublicKeyResponse", - "shortName": "import_ssh_public_key" - }, - "description": "Sample for ImportSshPublicKey", - "file": "oslogin_v1_generated_os_login_service_import_ssh_public_key_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_ImportSshPublicKey_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": "oslogin_v1_generated_os_login_service_import_ssh_public_key_sync.py" - }, - { - "canonical": true, - "clientMethod": { - "async": true, - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient", - "shortName": "OsLoginServiceAsyncClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceAsyncClient.update_ssh_public_key", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.UpdateSshPublicKey", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "UpdateSshPublicKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "ssh_public_key", - "type": "google.cloud.oslogin.common.types.SshPublicKey" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.oslogin.common.types.SshPublicKey", - "shortName": "update_ssh_public_key" - }, - "description": "Sample for UpdateSshPublicKey", - "file": "oslogin_v1_generated_os_login_service_update_ssh_public_key_async.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_UpdateSshPublicKey_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": "oslogin_v1_generated_os_login_service_update_ssh_public_key_async.py" - }, - { - "canonical": true, - "clientMethod": { - "client": { - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient", - "shortName": "OsLoginServiceClient" - }, - "fullName": "google.cloud.oslogin_v1.OsLoginServiceClient.update_ssh_public_key", - "method": { - "fullName": "google.cloud.oslogin.v1.OsLoginService.UpdateSshPublicKey", - "service": { - "fullName": "google.cloud.oslogin.v1.OsLoginService", - "shortName": "OsLoginService" - }, - "shortName": "UpdateSshPublicKey" - }, - "parameters": [ - { - "name": "request", - "type": "google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest" - }, - { - "name": "name", - "type": "str" - }, - { - "name": "ssh_public_key", - "type": "google.cloud.oslogin.common.types.SshPublicKey" - }, - { - "name": "update_mask", - "type": "google.protobuf.field_mask_pb2.FieldMask" - }, - { - "name": "retry", - "type": "google.api_core.retry.Retry" - }, - { - "name": "timeout", - "type": "float" - }, - { - "name": "metadata", - "type": "Sequence[Tuple[str, str]" - } - ], - "resultType": "google.cloud.oslogin.common.types.SshPublicKey", - "shortName": "update_ssh_public_key" - }, - "description": "Sample for UpdateSshPublicKey", - "file": "oslogin_v1_generated_os_login_service_update_ssh_public_key_sync.py", - "language": "PYTHON", - "origin": "API_DEFINITION", - "regionTag": "oslogin_v1_generated_OsLoginService_UpdateSshPublicKey_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": "oslogin_v1_generated_os_login_service_update_ssh_public_key_sync.py" - } - ] -} diff --git a/owl-bot-staging/google-cloud-os-login/v1/scripts/fixup_oslogin_v1_keywords.py b/owl-bot-staging/google-cloud-os-login/v1/scripts/fixup_oslogin_v1_keywords.py deleted file mode 100644 index 62869d14c125..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/scripts/fixup_oslogin_v1_keywords.py +++ /dev/null @@ -1,182 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 osloginCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - 'create_ssh_public_key': ('parent', 'ssh_public_key', ), - 'delete_posix_account': ('name', ), - 'delete_ssh_public_key': ('name', ), - 'get_login_profile': ('name', 'project_id', 'system_id', ), - 'get_ssh_public_key': ('name', ), - 'import_ssh_public_key': ('parent', 'ssh_public_key', 'project_id', 'regions', ), - 'update_ssh_public_key': ('name', 'ssh_public_key', 'update_mask', ), - } - - 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=osloginCallTransformer(), -): - """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 oslogin 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/google-cloud-os-login/v1/setup.py b/owl-bot-staging/google-cloud-os-login/v1/setup.py deleted file mode 100644 index 92482281d8bf..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/setup.py +++ /dev/null @@ -1,93 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 re - -import setuptools # type: ignore - -package_root = os.path.abspath(os.path.dirname(__file__)) - -name = 'google-cloud-os-login' - - -description = "Google Cloud Os Login API client library" - -version = None - -with open(os.path.join(package_root, 'google/cloud/oslogin/gapic_version.py')) as fp: - version_candidates = re.findall(r"(?<=\")\d+.\d+.\d+(?=\")", fp.read()) - assert (len(version_candidates) == 1) - version = version_candidates[0] - -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.1, <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.*", - # Exclude incompatible versions of `google-auth` - # See https://github.com/googleapis/google-cloud-python/issues/12364 - "google-auth >= 2.14.1, <3.0.0dev,!=2.24.0,!=2.25.0", - "proto-plus >= 1.22.3, <2.0.0dev", - "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/google-cloud-python/tree/main/packages/google-cloud-os-login" - -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.find_namespace_packages() - if package.startswith("google") -] - -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", - "Programming Language :: Python :: 3.12", - "Operating System :: OS Independent", - "Topic :: Internet", - ], - platforms="Posix; MacOS X; Windows", - packages=packages, - python_requires=">=3.7", - install_requires=dependencies, - include_package_data=True, - zip_safe=False, -) diff --git a/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.10.txt b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.10.txt deleted file mode 100644 index ed7f9aed2559..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/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/google-cloud-os-login/v1/testing/constraints-3.11.txt b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.11.txt deleted file mode 100644 index ed7f9aed2559..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/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/google-cloud-os-login/v1/testing/constraints-3.12.txt b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.12.txt deleted file mode 100644 index ed7f9aed2559..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/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/google-cloud-os-login/v1/testing/constraints-3.7.txt b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.7.txt deleted file mode 100644 index b8a550c73855..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.7.txt +++ /dev/null @@ -1,10 +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.1 -google-auth==2.14.1 -proto-plus==1.22.3 -protobuf==3.19.5 diff --git a/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.8.txt b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.8.txt deleted file mode 100644 index ed7f9aed2559..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/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/google-cloud-os-login/v1/testing/constraints-3.9.txt b/owl-bot-staging/google-cloud-os-login/v1/testing/constraints-3.9.txt deleted file mode 100644 index ed7f9aed2559..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/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/google-cloud-os-login/v1/tests/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/tests/__init__.py deleted file mode 100644 index 7b3de3117f38..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/tests/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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/google-cloud-os-login/v1/tests/unit/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/tests/unit/__init__.py deleted file mode 100644 index 7b3de3117f38..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/tests/unit/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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/google-cloud-os-login/v1/tests/unit/gapic/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/__init__.py deleted file mode 100644 index 7b3de3117f38..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/__init__.py b/owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/__init__.py deleted file mode 100644 index 7b3de3117f38..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ - -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py b/owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py deleted file mode 100644 index dcc731d785a4..000000000000 --- a/owl-bot-staging/google-cloud-os-login/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py +++ /dev/null @@ -1,6129 +0,0 @@ -# -*- coding: utf-8 -*- -# Copyright 2024 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT 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 google.api_core import api_core_version -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.oslogin.common.types import common -from google.cloud.oslogin_v1.services.os_login_service import OsLoginServiceAsyncClient -from google.cloud.oslogin_v1.services.os_login_service import OsLoginServiceClient -from google.cloud.oslogin_v1.services.os_login_service import transports -from google.cloud.oslogin_v1.types import oslogin -from google.oauth2 import service_account -from google.protobuf import field_mask_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 - -# If default endpoint template is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint template so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint_template(client): - return "test.{UNIVERSE_DOMAIN}" if ("localhost" in client._DEFAULT_ENDPOINT_TEMPLATE) else client._DEFAULT_ENDPOINT_TEMPLATE - - -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 OsLoginServiceClient._get_default_mtls_endpoint(None) is None - assert OsLoginServiceClient._get_default_mtls_endpoint(api_endpoint) == api_mtls_endpoint - assert OsLoginServiceClient._get_default_mtls_endpoint(api_mtls_endpoint) == api_mtls_endpoint - assert OsLoginServiceClient._get_default_mtls_endpoint(sandbox_endpoint) == sandbox_mtls_endpoint - assert OsLoginServiceClient._get_default_mtls_endpoint(sandbox_mtls_endpoint) == sandbox_mtls_endpoint - assert OsLoginServiceClient._get_default_mtls_endpoint(non_googleapi) == non_googleapi - -def test__read_environment_variables(): - assert OsLoginServiceClient._read_environment_variables() == (False, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - assert OsLoginServiceClient._read_environment_variables() == (True, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "false"}): - assert OsLoginServiceClient._read_environment_variables() == (False, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError) as excinfo: - OsLoginServiceClient._read_environment_variables() - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - assert OsLoginServiceClient._read_environment_variables() == (False, "never", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - assert OsLoginServiceClient._read_environment_variables() == (False, "always", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}): - assert OsLoginServiceClient._read_environment_variables() == (False, "auto", None) - - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError) as excinfo: - OsLoginServiceClient._read_environment_variables() - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" - - with mock.patch.dict(os.environ, {"GOOGLE_CLOUD_UNIVERSE_DOMAIN": "foo.com"}): - assert OsLoginServiceClient._read_environment_variables() == (False, "auto", "foo.com") - -def test__get_client_cert_source(): - mock_provided_cert_source = mock.Mock() - mock_default_cert_source = mock.Mock() - - assert OsLoginServiceClient._get_client_cert_source(None, False) is None - assert OsLoginServiceClient._get_client_cert_source(mock_provided_cert_source, False) is None - assert OsLoginServiceClient._get_client_cert_source(mock_provided_cert_source, True) == mock_provided_cert_source - - 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_default_cert_source): - assert OsLoginServiceClient._get_client_cert_source(None, True) is mock_default_cert_source - assert OsLoginServiceClient._get_client_cert_source(mock_provided_cert_source, "true") is mock_provided_cert_source - -@mock.patch.object(OsLoginServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceClient)) -@mock.patch.object(OsLoginServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceAsyncClient)) -def test__get_api_endpoint(): - api_override = "foo.com" - mock_client_cert_source = mock.Mock() - default_universe = OsLoginServiceClient._DEFAULT_UNIVERSE - default_endpoint = OsLoginServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) - mock_universe = "bar.com" - mock_endpoint = OsLoginServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) - - assert OsLoginServiceClient._get_api_endpoint(api_override, mock_client_cert_source, default_universe, "always") == api_override - assert OsLoginServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "auto") == OsLoginServiceClient.DEFAULT_MTLS_ENDPOINT - assert OsLoginServiceClient._get_api_endpoint(None, None, default_universe, "auto") == default_endpoint - assert OsLoginServiceClient._get_api_endpoint(None, None, default_universe, "always") == OsLoginServiceClient.DEFAULT_MTLS_ENDPOINT - assert OsLoginServiceClient._get_api_endpoint(None, mock_client_cert_source, default_universe, "always") == OsLoginServiceClient.DEFAULT_MTLS_ENDPOINT - assert OsLoginServiceClient._get_api_endpoint(None, None, mock_universe, "never") == mock_endpoint - assert OsLoginServiceClient._get_api_endpoint(None, None, default_universe, "never") == default_endpoint - - with pytest.raises(MutualTLSChannelError) as excinfo: - OsLoginServiceClient._get_api_endpoint(None, mock_client_cert_source, mock_universe, "auto") - assert str(excinfo.value) == "mTLS is not supported in any universe other than googleapis.com." - - -def test__get_universe_domain(): - client_universe_domain = "foo.com" - universe_domain_env = "bar.com" - - assert OsLoginServiceClient._get_universe_domain(client_universe_domain, universe_domain_env) == client_universe_domain - assert OsLoginServiceClient._get_universe_domain(None, universe_domain_env) == universe_domain_env - assert OsLoginServiceClient._get_universe_domain(None, None) == OsLoginServiceClient._DEFAULT_UNIVERSE - - with pytest.raises(ValueError) as excinfo: - OsLoginServiceClient._get_universe_domain("", None) - assert str(excinfo.value) == "Universe Domain cannot be an empty string." - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc"), - (OsLoginServiceClient, transports.OsLoginServiceRestTransport, "rest"), -]) -def test__validate_universe_domain(client_class, transport_class, transport_name): - client = client_class( - transport=transport_class( - credentials=ga_credentials.AnonymousCredentials() - ) - ) - assert client._validate_universe_domain() == True - - # Test the case when universe is already validated. - assert client._validate_universe_domain() == True - - if transport_name == "grpc": - # Test the case where credentials are provided by the - # `local_channel_credentials`. The default universes in both match. - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - client = client_class(transport=transport_class(channel=channel)) - assert client._validate_universe_domain() == True - - # Test the case where credentials do not exist: e.g. a transport is provided - # with no credentials. Validation should still succeed because there is no - # mismatch with non-existent credentials. - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - transport=transport_class(channel=channel) - transport._credentials = None - client = client_class(transport=transport) - assert client._validate_universe_domain() == True - - # TODO: This is needed to cater for older versions of google-auth - # Make this test unconditional once the minimum supported version of - # google-auth becomes 2.23.0 or higher. - google_auth_major, google_auth_minor = [int(part) for part in google.auth.__version__.split(".")[0:2]] - if google_auth_major > 2 or (google_auth_major == 2 and google_auth_minor >= 23): - credentials = ga_credentials.AnonymousCredentials() - credentials._universe_domain = "foo.com" - # Test the case when there is a universe mismatch from the credentials. - client = client_class( - transport=transport_class(credentials=credentials) - ) - with pytest.raises(ValueError) as excinfo: - client._validate_universe_domain() - assert str(excinfo.value) == "The configured universe domain (googleapis.com) does not match the universe domain found in the credentials (foo.com). If you haven't configured the universe domain explicitly, `googleapis.com` is the default." - - # Test the case when there is a universe mismatch from the client. - # - # TODO: Make this test unconditional once the minimum supported version of - # google-api-core becomes 2.15.0 or higher. - api_core_major, api_core_minor = [int(part) for part in api_core_version.__version__.split(".")[0:2]] - if api_core_major > 2 or (api_core_major == 2 and api_core_minor >= 15): - client = client_class(client_options={"universe_domain": "bar.com"}, transport=transport_class(credentials=ga_credentials.AnonymousCredentials(),)) - with pytest.raises(ValueError) as excinfo: - client._validate_universe_domain() - assert str(excinfo.value) == "The configured universe domain (bar.com) does not match the universe domain found in the credentials (googleapis.com). If you haven't configured the universe domain explicitly, `googleapis.com` is the default." - - # Test that ValueError is raised if universe_domain is provided via client options and credentials is None - with pytest.raises(ValueError): - client._compare_universes("foo.bar", None) - - -@pytest.mark.parametrize("client_class,transport_name", [ - (OsLoginServiceClient, "grpc"), - (OsLoginServiceAsyncClient, "grpc_asyncio"), - (OsLoginServiceClient, "rest"), -]) -def test_os_login_service_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 == ( - 'oslogin.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://oslogin.googleapis.com' - ) - - -@pytest.mark.parametrize("transport_class,transport_name", [ - (transports.OsLoginServiceGrpcTransport, "grpc"), - (transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (transports.OsLoginServiceRestTransport, "rest"), -]) -def test_os_login_service_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", [ - (OsLoginServiceClient, "grpc"), - (OsLoginServiceAsyncClient, "grpc_asyncio"), - (OsLoginServiceClient, "rest"), -]) -def test_os_login_service_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 == ( - 'oslogin.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else - 'https://oslogin.googleapis.com' - ) - - -def test_os_login_service_client_get_transport_class(): - transport = OsLoginServiceClient.get_transport_class() - available_transports = [ - transports.OsLoginServiceGrpcTransport, - transports.OsLoginServiceRestTransport, - ] - assert transport in available_transports - - transport = OsLoginServiceClient.get_transport_class("grpc") - assert transport == transports.OsLoginServiceGrpcTransport - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc"), - (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (OsLoginServiceClient, transports.OsLoginServiceRestTransport, "rest"), -]) -@mock.patch.object(OsLoginServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceClient)) -@mock.patch.object(OsLoginServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceAsyncClient)) -def test_os_login_service_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(OsLoginServiceClient, '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(OsLoginServiceClient, '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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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) as excinfo: - client = client_class(transport=transport_name) - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" - - # 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) as excinfo: - client = client_class(transport=transport_name) - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" - - # 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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", [ - (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc", "true"), - (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio", "true"), - (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc", "false"), - (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio", "false"), - (OsLoginServiceClient, transports.OsLoginServiceRestTransport, "rest", "true"), - (OsLoginServiceClient, transports.OsLoginServiceRestTransport, "rest", "false"), -]) -@mock.patch.object(OsLoginServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceClient)) -@mock.patch.object(OsLoginServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceAsyncClient)) -@mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "auto"}) -def test_os_login_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) - 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE) - 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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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", [ - OsLoginServiceClient, OsLoginServiceAsyncClient -]) -@mock.patch.object(OsLoginServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OsLoginServiceClient)) -@mock.patch.object(OsLoginServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OsLoginServiceAsyncClient)) -def test_os_login_service_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 - - # 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) as excinfo: - client_class.get_mtls_endpoint_and_cert_source() - - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_MTLS_ENDPOINT` must be `never`, `auto` or `always`" - - # 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) as excinfo: - client_class.get_mtls_endpoint_and_cert_source() - - assert str(excinfo.value) == "Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be either `true` or `false`" - -@pytest.mark.parametrize("client_class", [ - OsLoginServiceClient, OsLoginServiceAsyncClient -]) -@mock.patch.object(OsLoginServiceClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceClient)) -@mock.patch.object(OsLoginServiceAsyncClient, "_DEFAULT_ENDPOINT_TEMPLATE", modify_default_endpoint_template(OsLoginServiceAsyncClient)) -def test_os_login_service_client_client_api_endpoint(client_class): - mock_client_cert_source = client_cert_source_callback - api_override = "foo.com" - default_universe = OsLoginServiceClient._DEFAULT_UNIVERSE - default_endpoint = OsLoginServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=default_universe) - mock_universe = "bar.com" - mock_endpoint = OsLoginServiceClient._DEFAULT_ENDPOINT_TEMPLATE.format(UNIVERSE_DOMAIN=mock_universe) - - # If ClientOptions.api_endpoint is set and GOOGLE_API_USE_CLIENT_CERTIFICATE="true", - # use ClientOptions.api_endpoint as the api endpoint regardless. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "true"}): - with mock.patch("google.auth.transport.requests.AuthorizedSession.configure_mtls_channel"): - options = client_options.ClientOptions(client_cert_source=mock_client_cert_source, api_endpoint=api_override) - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == api_override - - # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="never", - # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - client = client_class(credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == default_endpoint - - # If ClientOptions.api_endpoint is not set and GOOGLE_API_USE_MTLS_ENDPOINT="always", - # use the DEFAULT_MTLS_ENDPOINT as the api endpoint. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "always"}): - client = client_class(credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT - - # If ClientOptions.api_endpoint is not set, GOOGLE_API_USE_MTLS_ENDPOINT="auto" (default), - # GOOGLE_API_USE_CLIENT_CERTIFICATE="false" (default), default cert source doesn't exist, - # and ClientOptions.universe_domain="bar.com", - # use the _DEFAULT_ENDPOINT_TEMPLATE populated with universe domain as the api endpoint. - options = client_options.ClientOptions() - universe_exists = hasattr(options, "universe_domain") - if universe_exists: - options = client_options.ClientOptions(universe_domain=mock_universe) - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - else: - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == (mock_endpoint if universe_exists else default_endpoint) - assert client.universe_domain == (mock_universe if universe_exists else default_universe) - - # If ClientOptions does not have a universe domain attribute and GOOGLE_API_USE_MTLS_ENDPOINT="never", - # use the _DEFAULT_ENDPOINT_TEMPLATE populated with GDU as the api endpoint. - options = client_options.ClientOptions() - if hasattr(options, "universe_domain"): - delattr(options, "universe_domain") - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "never"}): - client = client_class(client_options=options, credentials=ga_credentials.AnonymousCredentials()) - assert client.api_endpoint == default_endpoint - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc"), - (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio"), - (OsLoginServiceClient, transports.OsLoginServiceRestTransport, "rest"), -]) -def test_os_login_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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", [ - (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc", grpc_helpers), - (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), - (OsLoginServiceClient, transports.OsLoginServiceRestTransport, "rest", None), -]) -def test_os_login_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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_os_login_service_client_client_options_from_dict(): - with mock.patch('google.cloud.oslogin_v1.services.os_login_service.transports.OsLoginServiceGrpcTransport.__init__') as grpc_transport: - grpc_transport.return_value = None - client = OsLoginServiceClient( - 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", [ - (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc", grpc_helpers), - (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio", grpc_helpers_async), -]) -def test_os_login_service_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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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( - "oslogin.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-platform.read-only', - 'https://www.googleapis.com/auth/compute', - 'https://www.googleapis.com/auth/compute.readonly', -), - scopes=None, - default_host="oslogin.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.CreateSshPublicKeyRequest, - dict, -]) -def test_create_ssh_public_key(request_type, transport: str = 'grpc'): - client = OsLoginServiceClient( - 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.create_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = common.SshPublicKey( - key='key_value', - expiration_time_usec=2144, - fingerprint='fingerprint_value', - name='name_value', - ) - response = client.create_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = oslogin.CreateSshPublicKeyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, common.SshPublicKey) - assert response.key == 'key_value' - assert response.expiration_time_usec == 2144 - assert response.fingerprint == 'fingerprint_value' - assert response.name == 'name_value' - - -def test_create_ssh_public_key_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 = OsLoginServiceClient( - 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.create_ssh_public_key), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.create_ssh_public_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.CreateSshPublicKeyRequest() - - -def test_create_ssh_public_key_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = oslogin.CreateSshPublicKeyRequest( - parent='parent_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_ssh_public_key), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.create_ssh_public_key(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.CreateSshPublicKeyRequest( - parent='parent_value', - ) - -def test_create_ssh_public_key_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_ssh_public_key in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_ssh_public_key] = mock_rpc - request = {} - client.create_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_create_ssh_public_key_empty_call_async(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc_asyncio', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey( - key='key_value', - expiration_time_usec=2144, - fingerprint='fingerprint_value', - name='name_value', - )) - response = await client.create_ssh_public_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.CreateSshPublicKeyRequest() - -@pytest.mark.asyncio -async def test_create_ssh_public_key_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.create_ssh_public_key in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - class AwaitableMock(mock.AsyncMock): - def __await__(self): - self.await_count += 1 - return iter([]) - mock_object = AwaitableMock() - client._client._transport._wrapped_methods[client._client._transport.create_ssh_public_key] = mock_object - - request = {} - await client.create_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_object.call_count == 1 - - await client.create_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_object.call_count == 2 - -@pytest.mark.asyncio -async def test_create_ssh_public_key_async(transport: str = 'grpc_asyncio', request_type=oslogin.CreateSshPublicKeyRequest): - client = OsLoginServiceAsyncClient( - 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.create_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey( - key='key_value', - expiration_time_usec=2144, - fingerprint='fingerprint_value', - name='name_value', - )) - response = await client.create_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = oslogin.CreateSshPublicKeyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, common.SshPublicKey) - assert response.key == 'key_value' - assert response.expiration_time_usec == 2144 - assert response.fingerprint == 'fingerprint_value' - assert response.name == 'name_value' - - -@pytest.mark.asyncio -async def test_create_ssh_public_key_async_from_dict(): - await test_create_ssh_public_key_async(request_type=dict) - - -def test_create_ssh_public_key_field_headers(): - client = OsLoginServiceClient( - 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 = oslogin.CreateSshPublicKeyRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_ssh_public_key), - '__call__') as call: - call.return_value = common.SshPublicKey() - client.create_ssh_public_key(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', - 'parent=parent_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_create_ssh_public_key_field_headers_async(): - client = OsLoginServiceAsyncClient( - 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 = oslogin.CreateSshPublicKeyRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_ssh_public_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey()) - await client.create_ssh_public_key(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', - 'parent=parent_value', - ) in kw['metadata'] - - -def test_create_ssh_public_key_flattened(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = common.SshPublicKey() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.create_ssh_public_key( - parent='parent_value', - ssh_public_key=common.SshPublicKey(key='key_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].parent - mock_val = 'parent_value' - assert arg == mock_val - arg = args[0].ssh_public_key - mock_val = common.SshPublicKey(key='key_value') - assert arg == mock_val - - -def test_create_ssh_public_key_flattened_error(): - client = OsLoginServiceClient( - 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.create_ssh_public_key( - oslogin.CreateSshPublicKeyRequest(), - parent='parent_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - ) - -@pytest.mark.asyncio -async def test_create_ssh_public_key_flattened_async(): - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.create_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = common.SshPublicKey() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.create_ssh_public_key( - parent='parent_value', - ssh_public_key=common.SshPublicKey(key='key_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].parent - mock_val = 'parent_value' - assert arg == mock_val - arg = args[0].ssh_public_key - mock_val = common.SshPublicKey(key='key_value') - assert arg == mock_val - -@pytest.mark.asyncio -async def test_create_ssh_public_key_flattened_error_async(): - client = OsLoginServiceAsyncClient( - 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.create_ssh_public_key( - oslogin.CreateSshPublicKeyRequest(), - parent='parent_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.DeletePosixAccountRequest, - dict, -]) -def test_delete_posix_account(request_type, transport: str = 'grpc'): - client = OsLoginServiceClient( - 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_posix_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_posix_account(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = oslogin.DeletePosixAccountRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_posix_account_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 = OsLoginServiceClient( - 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_posix_account), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.delete_posix_account() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.DeletePosixAccountRequest() - - -def test_delete_posix_account_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = oslogin.DeletePosixAccountRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_posix_account), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.delete_posix_account(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.DeletePosixAccountRequest( - name='name_value', - ) - -def test_delete_posix_account_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.delete_posix_account in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.delete_posix_account] = mock_rpc - request = {} - client.delete_posix_account(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.delete_posix_account(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_delete_posix_account_empty_call_async(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc_asyncio', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_posix_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_posix_account() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.DeletePosixAccountRequest() - -@pytest.mark.asyncio -async def test_delete_posix_account_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.delete_posix_account in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - class AwaitableMock(mock.AsyncMock): - def __await__(self): - self.await_count += 1 - return iter([]) - mock_object = AwaitableMock() - client._client._transport._wrapped_methods[client._client._transport.delete_posix_account] = mock_object - - request = {} - await client.delete_posix_account(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_object.call_count == 1 - - await client.delete_posix_account(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_object.call_count == 2 - -@pytest.mark.asyncio -async def test_delete_posix_account_async(transport: str = 'grpc_asyncio', request_type=oslogin.DeletePosixAccountRequest): - client = OsLoginServiceAsyncClient( - 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_posix_account), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_posix_account(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = oslogin.DeletePosixAccountRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_delete_posix_account_async_from_dict(): - await test_delete_posix_account_async(request_type=dict) - - -def test_delete_posix_account_field_headers(): - client = OsLoginServiceClient( - 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 = oslogin.DeletePosixAccountRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_posix_account), - '__call__') as call: - call.return_value = None - client.delete_posix_account(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', - 'name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_posix_account_field_headers_async(): - client = OsLoginServiceAsyncClient( - 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 = oslogin.DeletePosixAccountRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_posix_account), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_posix_account(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', - 'name=name_value', - ) in kw['metadata'] - - -def test_delete_posix_account_flattened(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_posix_account), - '__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_posix_account( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - - -def test_delete_posix_account_flattened_error(): - client = OsLoginServiceClient( - 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_posix_account( - oslogin.DeletePosixAccountRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_delete_posix_account_flattened_async(): - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_posix_account), - '__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_posix_account( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_delete_posix_account_flattened_error_async(): - client = OsLoginServiceAsyncClient( - 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_posix_account( - oslogin.DeletePosixAccountRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.DeleteSshPublicKeyRequest, - dict, -]) -def test_delete_ssh_public_key(request_type, transport: str = 'grpc'): - client = OsLoginServiceClient( - 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_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = None - response = client.delete_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = oslogin.DeleteSshPublicKeyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_ssh_public_key_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 = OsLoginServiceClient( - 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_ssh_public_key), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.delete_ssh_public_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.DeleteSshPublicKeyRequest() - - -def test_delete_ssh_public_key_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = oslogin.DeleteSshPublicKeyRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_ssh_public_key), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.delete_ssh_public_key(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.DeleteSshPublicKeyRequest( - name='name_value', - ) - -def test_delete_ssh_public_key_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.delete_ssh_public_key in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.delete_ssh_public_key] = mock_rpc - request = {} - client.delete_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.delete_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_delete_ssh_public_key_empty_call_async(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc_asyncio', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_ssh_public_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.DeleteSshPublicKeyRequest() - -@pytest.mark.asyncio -async def test_delete_ssh_public_key_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.delete_ssh_public_key in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - class AwaitableMock(mock.AsyncMock): - def __await__(self): - self.await_count += 1 - return iter([]) - mock_object = AwaitableMock() - client._client._transport._wrapped_methods[client._client._transport.delete_ssh_public_key] = mock_object - - request = {} - await client.delete_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_object.call_count == 1 - - await client.delete_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_object.call_count == 2 - -@pytest.mark.asyncio -async def test_delete_ssh_public_key_async(transport: str = 'grpc_asyncio', request_type=oslogin.DeleteSshPublicKeyRequest): - client = OsLoginServiceAsyncClient( - 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_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - response = await client.delete_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = oslogin.DeleteSshPublicKeyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert response is None - - -@pytest.mark.asyncio -async def test_delete_ssh_public_key_async_from_dict(): - await test_delete_ssh_public_key_async(request_type=dict) - - -def test_delete_ssh_public_key_field_headers(): - client = OsLoginServiceClient( - 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 = oslogin.DeleteSshPublicKeyRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_ssh_public_key), - '__call__') as call: - call.return_value = None - client.delete_ssh_public_key(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', - 'name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_delete_ssh_public_key_field_headers_async(): - client = OsLoginServiceAsyncClient( - 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 = oslogin.DeleteSshPublicKeyRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_ssh_public_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(None) - await client.delete_ssh_public_key(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', - 'name=name_value', - ) in kw['metadata'] - - -def test_delete_ssh_public_key_flattened(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_ssh_public_key), - '__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_ssh_public_key( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - - -def test_delete_ssh_public_key_flattened_error(): - client = OsLoginServiceClient( - 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_ssh_public_key( - oslogin.DeleteSshPublicKeyRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_delete_ssh_public_key_flattened_async(): - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.delete_ssh_public_key), - '__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_ssh_public_key( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_delete_ssh_public_key_flattened_error_async(): - client = OsLoginServiceAsyncClient( - 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_ssh_public_key( - oslogin.DeleteSshPublicKeyRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.GetLoginProfileRequest, - dict, -]) -def test_get_login_profile(request_type, transport: str = 'grpc'): - client = OsLoginServiceClient( - 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_login_profile), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = oslogin.LoginProfile( - name='name_value', - ) - response = client.get_login_profile(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = oslogin.GetLoginProfileRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, oslogin.LoginProfile) - assert response.name == 'name_value' - - -def test_get_login_profile_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 = OsLoginServiceClient( - 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_login_profile), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.get_login_profile() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.GetLoginProfileRequest() - - -def test_get_login_profile_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = oslogin.GetLoginProfileRequest( - name='name_value', - project_id='project_id_value', - system_id='system_id_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_login_profile), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.get_login_profile(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.GetLoginProfileRequest( - name='name_value', - project_id='project_id_value', - system_id='system_id_value', - ) - -def test_get_login_profile_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_login_profile in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_login_profile] = mock_rpc - request = {} - client.get_login_profile(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_login_profile(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_get_login_profile_empty_call_async(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc_asyncio', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_login_profile), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(oslogin.LoginProfile( - name='name_value', - )) - response = await client.get_login_profile() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.GetLoginProfileRequest() - -@pytest.mark.asyncio -async def test_get_login_profile_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.get_login_profile in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - class AwaitableMock(mock.AsyncMock): - def __await__(self): - self.await_count += 1 - return iter([]) - mock_object = AwaitableMock() - client._client._transport._wrapped_methods[client._client._transport.get_login_profile] = mock_object - - request = {} - await client.get_login_profile(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_object.call_count == 1 - - await client.get_login_profile(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_object.call_count == 2 - -@pytest.mark.asyncio -async def test_get_login_profile_async(transport: str = 'grpc_asyncio', request_type=oslogin.GetLoginProfileRequest): - client = OsLoginServiceAsyncClient( - 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_login_profile), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(oslogin.LoginProfile( - name='name_value', - )) - response = await client.get_login_profile(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = oslogin.GetLoginProfileRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, oslogin.LoginProfile) - assert response.name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_login_profile_async_from_dict(): - await test_get_login_profile_async(request_type=dict) - - -def test_get_login_profile_field_headers(): - client = OsLoginServiceClient( - 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 = oslogin.GetLoginProfileRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_login_profile), - '__call__') as call: - call.return_value = oslogin.LoginProfile() - client.get_login_profile(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', - 'name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_login_profile_field_headers_async(): - client = OsLoginServiceAsyncClient( - 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 = oslogin.GetLoginProfileRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_login_profile), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(oslogin.LoginProfile()) - await client.get_login_profile(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', - 'name=name_value', - ) in kw['metadata'] - - -def test_get_login_profile_flattened(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_login_profile), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = oslogin.LoginProfile() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_login_profile( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - - -def test_get_login_profile_flattened_error(): - client = OsLoginServiceClient( - 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_login_profile( - oslogin.GetLoginProfileRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_login_profile_flattened_async(): - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_login_profile), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = oslogin.LoginProfile() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(oslogin.LoginProfile()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_login_profile( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_get_login_profile_flattened_error_async(): - client = OsLoginServiceAsyncClient( - 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_login_profile( - oslogin.GetLoginProfileRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.GetSshPublicKeyRequest, - dict, -]) -def test_get_ssh_public_key(request_type, transport: str = 'grpc'): - client = OsLoginServiceClient( - 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_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = common.SshPublicKey( - key='key_value', - expiration_time_usec=2144, - fingerprint='fingerprint_value', - name='name_value', - ) - response = client.get_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = oslogin.GetSshPublicKeyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, common.SshPublicKey) - assert response.key == 'key_value' - assert response.expiration_time_usec == 2144 - assert response.fingerprint == 'fingerprint_value' - assert response.name == 'name_value' - - -def test_get_ssh_public_key_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 = OsLoginServiceClient( - 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_ssh_public_key), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.get_ssh_public_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.GetSshPublicKeyRequest() - - -def test_get_ssh_public_key_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = oslogin.GetSshPublicKeyRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_ssh_public_key), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.get_ssh_public_key(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.GetSshPublicKeyRequest( - name='name_value', - ) - -def test_get_ssh_public_key_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_ssh_public_key in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_ssh_public_key] = mock_rpc - request = {} - client.get_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_get_ssh_public_key_empty_call_async(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc_asyncio', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey( - key='key_value', - expiration_time_usec=2144, - fingerprint='fingerprint_value', - name='name_value', - )) - response = await client.get_ssh_public_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.GetSshPublicKeyRequest() - -@pytest.mark.asyncio -async def test_get_ssh_public_key_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.get_ssh_public_key in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - class AwaitableMock(mock.AsyncMock): - def __await__(self): - self.await_count += 1 - return iter([]) - mock_object = AwaitableMock() - client._client._transport._wrapped_methods[client._client._transport.get_ssh_public_key] = mock_object - - request = {} - await client.get_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_object.call_count == 1 - - await client.get_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_object.call_count == 2 - -@pytest.mark.asyncio -async def test_get_ssh_public_key_async(transport: str = 'grpc_asyncio', request_type=oslogin.GetSshPublicKeyRequest): - client = OsLoginServiceAsyncClient( - 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_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey( - key='key_value', - expiration_time_usec=2144, - fingerprint='fingerprint_value', - name='name_value', - )) - response = await client.get_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = oslogin.GetSshPublicKeyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, common.SshPublicKey) - assert response.key == 'key_value' - assert response.expiration_time_usec == 2144 - assert response.fingerprint == 'fingerprint_value' - assert response.name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_ssh_public_key_async_from_dict(): - await test_get_ssh_public_key_async(request_type=dict) - - -def test_get_ssh_public_key_field_headers(): - client = OsLoginServiceClient( - 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 = oslogin.GetSshPublicKeyRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_ssh_public_key), - '__call__') as call: - call.return_value = common.SshPublicKey() - client.get_ssh_public_key(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', - 'name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_get_ssh_public_key_field_headers_async(): - client = OsLoginServiceAsyncClient( - 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 = oslogin.GetSshPublicKeyRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_ssh_public_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey()) - await client.get_ssh_public_key(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', - 'name=name_value', - ) in kw['metadata'] - - -def test_get_ssh_public_key_flattened(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = common.SshPublicKey() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.get_ssh_public_key( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - - -def test_get_ssh_public_key_flattened_error(): - client = OsLoginServiceClient( - 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_ssh_public_key( - oslogin.GetSshPublicKeyRequest(), - name='name_value', - ) - -@pytest.mark.asyncio -async def test_get_ssh_public_key_flattened_async(): - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.get_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = common.SshPublicKey() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.get_ssh_public_key( - name='name_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].name - mock_val = 'name_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_get_ssh_public_key_flattened_error_async(): - client = OsLoginServiceAsyncClient( - 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_ssh_public_key( - oslogin.GetSshPublicKeyRequest(), - name='name_value', - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.ImportSshPublicKeyRequest, - dict, -]) -def test_import_ssh_public_key(request_type, transport: str = 'grpc'): - client = OsLoginServiceClient( - 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.import_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = oslogin.ImportSshPublicKeyResponse( - details='details_value', - ) - response = client.import_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = oslogin.ImportSshPublicKeyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, oslogin.ImportSshPublicKeyResponse) - assert response.details == 'details_value' - - -def test_import_ssh_public_key_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 = OsLoginServiceClient( - 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.import_ssh_public_key), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.import_ssh_public_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.ImportSshPublicKeyRequest() - - -def test_import_ssh_public_key_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = oslogin.ImportSshPublicKeyRequest( - parent='parent_value', - project_id='project_id_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.import_ssh_public_key), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.import_ssh_public_key(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.ImportSshPublicKeyRequest( - parent='parent_value', - project_id='project_id_value', - ) - -def test_import_ssh_public_key_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.import_ssh_public_key in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.import_ssh_public_key] = mock_rpc - request = {} - client.import_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.import_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_import_ssh_public_key_empty_call_async(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc_asyncio', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.import_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(oslogin.ImportSshPublicKeyResponse( - details='details_value', - )) - response = await client.import_ssh_public_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.ImportSshPublicKeyRequest() - -@pytest.mark.asyncio -async def test_import_ssh_public_key_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.import_ssh_public_key in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - class AwaitableMock(mock.AsyncMock): - def __await__(self): - self.await_count += 1 - return iter([]) - mock_object = AwaitableMock() - client._client._transport._wrapped_methods[client._client._transport.import_ssh_public_key] = mock_object - - request = {} - await client.import_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_object.call_count == 1 - - await client.import_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_object.call_count == 2 - -@pytest.mark.asyncio -async def test_import_ssh_public_key_async(transport: str = 'grpc_asyncio', request_type=oslogin.ImportSshPublicKeyRequest): - client = OsLoginServiceAsyncClient( - 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.import_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(oslogin.ImportSshPublicKeyResponse( - details='details_value', - )) - response = await client.import_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = oslogin.ImportSshPublicKeyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, oslogin.ImportSshPublicKeyResponse) - assert response.details == 'details_value' - - -@pytest.mark.asyncio -async def test_import_ssh_public_key_async_from_dict(): - await test_import_ssh_public_key_async(request_type=dict) - - -def test_import_ssh_public_key_field_headers(): - client = OsLoginServiceClient( - 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 = oslogin.ImportSshPublicKeyRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.import_ssh_public_key), - '__call__') as call: - call.return_value = oslogin.ImportSshPublicKeyResponse() - client.import_ssh_public_key(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', - 'parent=parent_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_import_ssh_public_key_field_headers_async(): - client = OsLoginServiceAsyncClient( - 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 = oslogin.ImportSshPublicKeyRequest() - - request.parent = 'parent_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.import_ssh_public_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(oslogin.ImportSshPublicKeyResponse()) - await client.import_ssh_public_key(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', - 'parent=parent_value', - ) in kw['metadata'] - - -def test_import_ssh_public_key_flattened(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.import_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = oslogin.ImportSshPublicKeyResponse() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.import_ssh_public_key( - parent='parent_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - project_id='project_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].parent - mock_val = 'parent_value' - assert arg == mock_val - arg = args[0].ssh_public_key - mock_val = common.SshPublicKey(key='key_value') - assert arg == mock_val - arg = args[0].project_id - mock_val = 'project_id_value' - assert arg == mock_val - - -def test_import_ssh_public_key_flattened_error(): - client = OsLoginServiceClient( - 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.import_ssh_public_key( - oslogin.ImportSshPublicKeyRequest(), - parent='parent_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - project_id='project_id_value', - ) - -@pytest.mark.asyncio -async def test_import_ssh_public_key_flattened_async(): - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.import_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = oslogin.ImportSshPublicKeyResponse() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(oslogin.ImportSshPublicKeyResponse()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.import_ssh_public_key( - parent='parent_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - project_id='project_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].parent - mock_val = 'parent_value' - assert arg == mock_val - arg = args[0].ssh_public_key - mock_val = common.SshPublicKey(key='key_value') - assert arg == mock_val - arg = args[0].project_id - mock_val = 'project_id_value' - assert arg == mock_val - -@pytest.mark.asyncio -async def test_import_ssh_public_key_flattened_error_async(): - client = OsLoginServiceAsyncClient( - 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.import_ssh_public_key( - oslogin.ImportSshPublicKeyRequest(), - parent='parent_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - project_id='project_id_value', - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.UpdateSshPublicKeyRequest, - dict, -]) -def test_update_ssh_public_key(request_type, transport: str = 'grpc'): - client = OsLoginServiceClient( - 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_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = common.SshPublicKey( - key='key_value', - expiration_time_usec=2144, - fingerprint='fingerprint_value', - name='name_value', - ) - response = client.update_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) == 1 - _, args, _ = call.mock_calls[0] - request = oslogin.UpdateSshPublicKeyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, common.SshPublicKey) - assert response.key == 'key_value' - assert response.expiration_time_usec == 2144 - assert response.fingerprint == 'fingerprint_value' - assert response.name == 'name_value' - - -def test_update_ssh_public_key_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 = OsLoginServiceClient( - 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_ssh_public_key), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.update_ssh_public_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.UpdateSshPublicKeyRequest() - - -def test_update_ssh_public_key_non_empty_request_with_auto_populated_field(): - # This test is a coverage failsafe to make sure that UUID4 fields are - # automatically populated, according to AIP-4235, with non-empty requests. - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc', - ) - - # Populate all string fields in the request which are not UUID4 - # since we want to check that UUID4 are populated automatically - # if they meet the requirements of AIP 4235. - request = oslogin.UpdateSshPublicKeyRequest( - name='name_value', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_ssh_public_key), - '__call__') as call: - call.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client.update_ssh_public_key(request=request) - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.UpdateSshPublicKeyRequest( - name='name_value', - ) - -def test_update_ssh_public_key_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="grpc", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.update_ssh_public_key in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.update_ssh_public_key] = mock_rpc - request = {} - client.update_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.update_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - -@pytest.mark.asyncio -async def test_update_ssh_public_key_empty_call_async(): - # This test is a coverage failsafe to make sure that totally empty calls, - # i.e. request == None and no flattened fields passed, work. - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='grpc_asyncio', - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey( - key='key_value', - expiration_time_usec=2144, - fingerprint='fingerprint_value', - name='name_value', - )) - response = await client.update_ssh_public_key() - call.assert_called() - _, args, _ = call.mock_calls[0] - assert args[0] == oslogin.UpdateSshPublicKeyRequest() - -@pytest.mark.asyncio -async def test_update_ssh_public_key_async_use_cached_wrapped_rpc(transport: str = "grpc_asyncio"): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method_async.wrap_method") as wrapper_fn: - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._client._transport.update_ssh_public_key in client._client._transport._wrapped_methods - - # Replace cached wrapped function with mock - class AwaitableMock(mock.AsyncMock): - def __await__(self): - self.await_count += 1 - return iter([]) - mock_object = AwaitableMock() - client._client._transport._wrapped_methods[client._client._transport.update_ssh_public_key] = mock_object - - request = {} - await client.update_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_object.call_count == 1 - - await client.update_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_object.call_count == 2 - -@pytest.mark.asyncio -async def test_update_ssh_public_key_async(transport: str = 'grpc_asyncio', request_type=oslogin.UpdateSshPublicKeyRequest): - client = OsLoginServiceAsyncClient( - 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_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value =grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey( - key='key_value', - expiration_time_usec=2144, - fingerprint='fingerprint_value', - name='name_value', - )) - response = await client.update_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert len(call.mock_calls) - _, args, _ = call.mock_calls[0] - request = oslogin.UpdateSshPublicKeyRequest() - assert args[0] == request - - # Establish that the response is the type that we expect. - assert isinstance(response, common.SshPublicKey) - assert response.key == 'key_value' - assert response.expiration_time_usec == 2144 - assert response.fingerprint == 'fingerprint_value' - assert response.name == 'name_value' - - -@pytest.mark.asyncio -async def test_update_ssh_public_key_async_from_dict(): - await test_update_ssh_public_key_async(request_type=dict) - - -def test_update_ssh_public_key_field_headers(): - client = OsLoginServiceClient( - 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 = oslogin.UpdateSshPublicKeyRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_ssh_public_key), - '__call__') as call: - call.return_value = common.SshPublicKey() - client.update_ssh_public_key(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', - 'name=name_value', - ) in kw['metadata'] - - -@pytest.mark.asyncio -async def test_update_ssh_public_key_field_headers_async(): - client = OsLoginServiceAsyncClient( - 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 = oslogin.UpdateSshPublicKeyRequest() - - request.name = 'name_value' - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_ssh_public_key), - '__call__') as call: - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey()) - await client.update_ssh_public_key(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', - 'name=name_value', - ) in kw['metadata'] - - -def test_update_ssh_public_key_flattened(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = common.SshPublicKey() - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - client.update_ssh_public_key( - name='name_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_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].name - mock_val = 'name_value' - assert arg == mock_val - arg = args[0].ssh_public_key - mock_val = common.SshPublicKey(key='key_value') - assert arg == mock_val - arg = args[0].update_mask - mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) - assert arg == mock_val - - -def test_update_ssh_public_key_flattened_error(): - client = OsLoginServiceClient( - 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_ssh_public_key( - oslogin.UpdateSshPublicKeyRequest(), - name='name_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - -@pytest.mark.asyncio -async def test_update_ssh_public_key_flattened_async(): - client = OsLoginServiceAsyncClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Mock the actual call within the gRPC stub, and fake the request. - with mock.patch.object( - type(client.transport.update_ssh_public_key), - '__call__') as call: - # Designate an appropriate return value for the call. - call.return_value = common.SshPublicKey() - - call.return_value = grpc_helpers_async.FakeUnaryUnaryCall(common.SshPublicKey()) - # Call the method with a truthy value for each flattened field, - # using the keyword arguments to the method. - response = await client.update_ssh_public_key( - name='name_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_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].name - mock_val = 'name_value' - assert arg == mock_val - arg = args[0].ssh_public_key - mock_val = common.SshPublicKey(key='key_value') - assert arg == mock_val - arg = args[0].update_mask - mock_val = field_mask_pb2.FieldMask(paths=['paths_value']) - assert arg == mock_val - -@pytest.mark.asyncio -async def test_update_ssh_public_key_flattened_error_async(): - client = OsLoginServiceAsyncClient( - 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_ssh_public_key( - oslogin.UpdateSshPublicKeyRequest(), - name='name_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.CreateSshPublicKeyRequest, - dict, -]) -def test_create_ssh_public_key_rest(request_type): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'users/sample1'} - request_init["ssh_public_key"] = {'key': 'key_value', 'expiration_time_usec': 2144, 'fingerprint': 'fingerprint_value', 'name': 'name_value'} - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = oslogin.CreateSshPublicKeyRequest.meta.fields["ssh_public_key"] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["ssh_public_key"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["ssh_public_key"][field])): - del request_init["ssh_public_key"][field][i][subfield] - else: - del request_init["ssh_public_key"][field][subfield] - 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 = common.SshPublicKey( - key='key_value', - expiration_time_usec=2144, - fingerprint='fingerprint_value', - name='name_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = common.SshPublicKey.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.create_ssh_public_key(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, common.SshPublicKey) - assert response.key == 'key_value' - assert response.expiration_time_usec == 2144 - assert response.fingerprint == 'fingerprint_value' - assert response.name == 'name_value' - -def test_create_ssh_public_key_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.create_ssh_public_key in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.create_ssh_public_key] = mock_rpc - - request = {} - client.create_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.create_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_create_ssh_public_key_rest_required_fields(request_type=oslogin.CreateSshPublicKeyRequest): - transport_class = transports.OsLoginServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_ssh_public_key._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["parent"] = 'parent_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).create_ssh_public_key._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' - - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = common.SshPublicKey() - # 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 - - # Convert return value to protobuf type - return_value = common.SshPublicKey.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.create_ssh_public_key(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_create_ssh_public_key_rest_unset_required_fields(): - transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.create_ssh_public_key._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("parent", "sshPublicKey", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_create_ssh_public_key_rest_interceptors(null_interceptor): - transport = transports.OsLoginServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), - ) - client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "post_create_ssh_public_key") as post, \ - mock.patch.object(transports.OsLoginServiceRestInterceptor, "pre_create_ssh_public_key") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = oslogin.CreateSshPublicKeyRequest.pb(oslogin.CreateSshPublicKeyRequest()) - 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 = common.SshPublicKey.to_json(common.SshPublicKey()) - - request = oslogin.CreateSshPublicKeyRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = common.SshPublicKey() - - client.create_ssh_public_key(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_create_ssh_public_key_rest_bad_request(transport: str = 'rest', request_type=oslogin.CreateSshPublicKeyRequest): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'users/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.create_ssh_public_key(request) - - -def test_create_ssh_public_key_rest_flattened(): - client = OsLoginServiceClient( - 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 = common.SshPublicKey() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'users/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = common.SshPublicKey.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.create_ssh_public_key(**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/v1/{parent=users/*}/sshPublicKeys" % client.transport._host, args[1]) - - -def test_create_ssh_public_key_rest_flattened_error(transport: str = 'rest'): - client = OsLoginServiceClient( - 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.create_ssh_public_key( - oslogin.CreateSshPublicKeyRequest(), - parent='parent_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - ) - - -def test_create_ssh_public_key_rest_error(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.DeletePosixAccountRequest, - dict, -]) -def test_delete_posix_account_rest(request_type): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'users/sample1/projects/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_posix_account(request) - - # Establish that the response is the type that we expect. - assert response is None - -def test_delete_posix_account_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.delete_posix_account in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.delete_posix_account] = mock_rpc - - request = {} - client.delete_posix_account(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.delete_posix_account(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_delete_posix_account_rest_required_fields(request_type=oslogin.DeletePosixAccountRequest): - transport_class = transports.OsLoginServiceRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_posix_account._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["name"] = 'name_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_posix_account._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = OsLoginServiceClient( - 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_posix_account(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_posix_account_rest_unset_required_fields(): - transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_posix_account._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_posix_account_rest_interceptors(null_interceptor): - transport = transports.OsLoginServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), - ) - client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "pre_delete_posix_account") as pre: - pre.assert_not_called() - pb_message = oslogin.DeletePosixAccountRequest.pb(oslogin.DeletePosixAccountRequest()) - 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 = oslogin.DeletePosixAccountRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.delete_posix_account(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_delete_posix_account_rest_bad_request(transport: str = 'rest', request_type=oslogin.DeletePosixAccountRequest): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'users/sample1/projects/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_posix_account(request) - - -def test_delete_posix_account_rest_flattened(): - client = OsLoginServiceClient( - 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 = {'name': 'users/sample1/projects/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_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_posix_account(**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/v1/{name=users/*/projects/*}" % client.transport._host, args[1]) - - -def test_delete_posix_account_rest_flattened_error(transport: str = 'rest'): - client = OsLoginServiceClient( - 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_posix_account( - oslogin.DeletePosixAccountRequest(), - name='name_value', - ) - - -def test_delete_posix_account_rest_error(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.DeleteSshPublicKeyRequest, - dict, -]) -def test_delete_ssh_public_key_rest(request_type): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'users/sample1/sshPublicKeys/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_ssh_public_key(request) - - # Establish that the response is the type that we expect. - assert response is None - -def test_delete_ssh_public_key_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.delete_ssh_public_key in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.delete_ssh_public_key] = mock_rpc - - request = {} - client.delete_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.delete_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_delete_ssh_public_key_rest_required_fields(request_type=oslogin.DeleteSshPublicKeyRequest): - transport_class = transports.OsLoginServiceRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_ssh_public_key._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["name"] = 'name_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).delete_ssh_public_key._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = OsLoginServiceClient( - 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_ssh_public_key(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_delete_ssh_public_key_rest_unset_required_fields(): - transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.delete_ssh_public_key._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_delete_ssh_public_key_rest_interceptors(null_interceptor): - transport = transports.OsLoginServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), - ) - client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "pre_delete_ssh_public_key") as pre: - pre.assert_not_called() - pb_message = oslogin.DeleteSshPublicKeyRequest.pb(oslogin.DeleteSshPublicKeyRequest()) - 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 = oslogin.DeleteSshPublicKeyRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - - client.delete_ssh_public_key(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - - -def test_delete_ssh_public_key_rest_bad_request(transport: str = 'rest', request_type=oslogin.DeleteSshPublicKeyRequest): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'users/sample1/sshPublicKeys/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_ssh_public_key(request) - - -def test_delete_ssh_public_key_rest_flattened(): - client = OsLoginServiceClient( - 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 = {'name': 'users/sample1/sshPublicKeys/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_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_ssh_public_key(**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/v1/{name=users/*/sshPublicKeys/*}" % client.transport._host, args[1]) - - -def test_delete_ssh_public_key_rest_flattened_error(transport: str = 'rest'): - client = OsLoginServiceClient( - 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_ssh_public_key( - oslogin.DeleteSshPublicKeyRequest(), - name='name_value', - ) - - -def test_delete_ssh_public_key_rest_error(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.GetLoginProfileRequest, - dict, -]) -def test_get_login_profile_rest(request_type): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'users/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 = oslogin.LoginProfile( - name='name_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = oslogin.LoginProfile.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.get_login_profile(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, oslogin.LoginProfile) - assert response.name == 'name_value' - -def test_get_login_profile_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_login_profile in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_login_profile] = mock_rpc - - request = {} - client.get_login_profile(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_login_profile(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_get_login_profile_rest_required_fields(request_type=oslogin.GetLoginProfileRequest): - transport_class = transports.OsLoginServiceRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_login_profile._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["name"] = 'name_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_login_profile._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("project_id", "system_id", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = oslogin.LoginProfile() - # 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 - - # Convert return value to protobuf type - return_value = oslogin.LoginProfile.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.get_login_profile(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_login_profile_rest_unset_required_fields(): - transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_login_profile._get_unset_required_fields({}) - assert set(unset_fields) == (set(("projectId", "systemId", )) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_login_profile_rest_interceptors(null_interceptor): - transport = transports.OsLoginServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), - ) - client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "post_get_login_profile") as post, \ - mock.patch.object(transports.OsLoginServiceRestInterceptor, "pre_get_login_profile") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = oslogin.GetLoginProfileRequest.pb(oslogin.GetLoginProfileRequest()) - 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 = oslogin.LoginProfile.to_json(oslogin.LoginProfile()) - - request = oslogin.GetLoginProfileRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = oslogin.LoginProfile() - - client.get_login_profile(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_login_profile_rest_bad_request(transport: str = 'rest', request_type=oslogin.GetLoginProfileRequest): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'users/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.get_login_profile(request) - - -def test_get_login_profile_rest_flattened(): - client = OsLoginServiceClient( - 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 = oslogin.LoginProfile() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'users/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = oslogin.LoginProfile.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.get_login_profile(**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/v1/{name=users/*}/loginProfile" % client.transport._host, args[1]) - - -def test_get_login_profile_rest_flattened_error(transport: str = 'rest'): - client = OsLoginServiceClient( - 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_login_profile( - oslogin.GetLoginProfileRequest(), - name='name_value', - ) - - -def test_get_login_profile_rest_error(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.GetSshPublicKeyRequest, - dict, -]) -def test_get_ssh_public_key_rest(request_type): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'users/sample1/sshPublicKeys/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 = common.SshPublicKey( - key='key_value', - expiration_time_usec=2144, - fingerprint='fingerprint_value', - name='name_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = common.SshPublicKey.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.get_ssh_public_key(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, common.SshPublicKey) - assert response.key == 'key_value' - assert response.expiration_time_usec == 2144 - assert response.fingerprint == 'fingerprint_value' - assert response.name == 'name_value' - -def test_get_ssh_public_key_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.get_ssh_public_key in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.get_ssh_public_key] = mock_rpc - - request = {} - client.get_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.get_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_get_ssh_public_key_rest_required_fields(request_type=oslogin.GetSshPublicKeyRequest): - transport_class = transports.OsLoginServiceRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_ssh_public_key._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["name"] = 'name_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).get_ssh_public_key._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = common.SshPublicKey() - # 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 - - # Convert return value to protobuf type - return_value = common.SshPublicKey.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.get_ssh_public_key(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_get_ssh_public_key_rest_unset_required_fields(): - transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.get_ssh_public_key._get_unset_required_fields({}) - assert set(unset_fields) == (set(()) & set(("name", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_get_ssh_public_key_rest_interceptors(null_interceptor): - transport = transports.OsLoginServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), - ) - client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "post_get_ssh_public_key") as post, \ - mock.patch.object(transports.OsLoginServiceRestInterceptor, "pre_get_ssh_public_key") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = oslogin.GetSshPublicKeyRequest.pb(oslogin.GetSshPublicKeyRequest()) - 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 = common.SshPublicKey.to_json(common.SshPublicKey()) - - request = oslogin.GetSshPublicKeyRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = common.SshPublicKey() - - client.get_ssh_public_key(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_get_ssh_public_key_rest_bad_request(transport: str = 'rest', request_type=oslogin.GetSshPublicKeyRequest): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'users/sample1/sshPublicKeys/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_ssh_public_key(request) - - -def test_get_ssh_public_key_rest_flattened(): - client = OsLoginServiceClient( - 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 = common.SshPublicKey() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'users/sample1/sshPublicKeys/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = common.SshPublicKey.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.get_ssh_public_key(**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/v1/{name=users/*/sshPublicKeys/*}" % client.transport._host, args[1]) - - -def test_get_ssh_public_key_rest_flattened_error(transport: str = 'rest'): - client = OsLoginServiceClient( - 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_ssh_public_key( - oslogin.GetSshPublicKeyRequest(), - name='name_value', - ) - - -def test_get_ssh_public_key_rest_error(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.ImportSshPublicKeyRequest, - dict, -]) -def test_import_ssh_public_key_rest(request_type): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'users/sample1'} - request_init["ssh_public_key"] = {'key': 'key_value', 'expiration_time_usec': 2144, 'fingerprint': 'fingerprint_value', 'name': 'name_value'} - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = oslogin.ImportSshPublicKeyRequest.meta.fields["ssh_public_key"] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["ssh_public_key"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["ssh_public_key"][field])): - del request_init["ssh_public_key"][field][i][subfield] - else: - del request_init["ssh_public_key"][field][subfield] - 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 = oslogin.ImportSshPublicKeyResponse( - details='details_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = oslogin.ImportSshPublicKeyResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.import_ssh_public_key(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, oslogin.ImportSshPublicKeyResponse) - assert response.details == 'details_value' - -def test_import_ssh_public_key_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.import_ssh_public_key in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.import_ssh_public_key] = mock_rpc - - request = {} - client.import_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.import_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_import_ssh_public_key_rest_required_fields(request_type=oslogin.ImportSshPublicKeyRequest): - transport_class = transports.OsLoginServiceRestTransport - - request_init = {} - request_init["parent"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).import_ssh_public_key._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["parent"] = 'parent_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).import_ssh_public_key._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("project_id", "regions", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "parent" in jsonified_request - assert jsonified_request["parent"] == 'parent_value' - - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = oslogin.ImportSshPublicKeyResponse() - # 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 - - # Convert return value to protobuf type - return_value = oslogin.ImportSshPublicKeyResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.import_ssh_public_key(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_import_ssh_public_key_rest_unset_required_fields(): - transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.import_ssh_public_key._get_unset_required_fields({}) - assert set(unset_fields) == (set(("projectId", "regions", )) & set(("parent", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_import_ssh_public_key_rest_interceptors(null_interceptor): - transport = transports.OsLoginServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), - ) - client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "post_import_ssh_public_key") as post, \ - mock.patch.object(transports.OsLoginServiceRestInterceptor, "pre_import_ssh_public_key") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = oslogin.ImportSshPublicKeyRequest.pb(oslogin.ImportSshPublicKeyRequest()) - 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 = oslogin.ImportSshPublicKeyResponse.to_json(oslogin.ImportSshPublicKeyResponse()) - - request = oslogin.ImportSshPublicKeyRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = oslogin.ImportSshPublicKeyResponse() - - client.import_ssh_public_key(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_import_ssh_public_key_rest_bad_request(transport: str = 'rest', request_type=oslogin.ImportSshPublicKeyRequest): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'parent': 'users/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.import_ssh_public_key(request) - - -def test_import_ssh_public_key_rest_flattened(): - client = OsLoginServiceClient( - 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 = oslogin.ImportSshPublicKeyResponse() - - # get arguments that satisfy an http rule for this method - sample_request = {'parent': 'users/sample1'} - - # get truthy value for each flattened field - mock_args = dict( - parent='parent_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - project_id='project_id_value', - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = oslogin.ImportSshPublicKeyResponse.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.import_ssh_public_key(**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/v1/{parent=users/*}:importSshPublicKey" % client.transport._host, args[1]) - - -def test_import_ssh_public_key_rest_flattened_error(transport: str = 'rest'): - client = OsLoginServiceClient( - 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.import_ssh_public_key( - oslogin.ImportSshPublicKeyRequest(), - parent='parent_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - project_id='project_id_value', - ) - - -def test_import_ssh_public_key_rest_error(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -@pytest.mark.parametrize("request_type", [ - oslogin.UpdateSshPublicKeyRequest, - dict, -]) -def test_update_ssh_public_key_rest(request_type): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'users/sample1/sshPublicKeys/sample2'} - request_init["ssh_public_key"] = {'key': 'key_value', 'expiration_time_usec': 2144, 'fingerprint': 'fingerprint_value', 'name': 'name_value'} - # The version of a generated dependency at test runtime may differ from the version used during generation. - # Delete any fields which are not present in the current runtime dependency - # See https://github.com/googleapis/gapic-generator-python/issues/1748 - - # Determine if the message type is proto-plus or protobuf - test_field = oslogin.UpdateSshPublicKeyRequest.meta.fields["ssh_public_key"] - - def get_message_fields(field): - # Given a field which is a message (composite type), return a list with - # all the fields of the message. - # If the field is not a composite type, return an empty list. - message_fields = [] - - if hasattr(field, "message") and field.message: - is_field_type_proto_plus_type = not hasattr(field.message, "DESCRIPTOR") - - if is_field_type_proto_plus_type: - message_fields = field.message.meta.fields.values() - # Add `# pragma: NO COVER` because there may not be any `*_pb2` field types - else: # pragma: NO COVER - message_fields = field.message.DESCRIPTOR.fields - return message_fields - - runtime_nested_fields = [ - (field.name, nested_field.name) - for field in get_message_fields(test_field) - for nested_field in get_message_fields(field) - ] - - subfields_not_in_runtime = [] - - # For each item in the sample request, create a list of sub fields which are not present at runtime - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for field, value in request_init["ssh_public_key"].items(): # pragma: NO COVER - result = None - is_repeated = False - # For repeated fields - if isinstance(value, list) and len(value): - is_repeated = True - result = value[0] - # For fields where the type is another message - if isinstance(value, dict): - result = value - - if result and hasattr(result, "keys"): - for subfield in result.keys(): - if (field, subfield) not in runtime_nested_fields: - subfields_not_in_runtime.append( - {"field": field, "subfield": subfield, "is_repeated": is_repeated} - ) - - # Remove fields from the sample request which are not present in the runtime version of the dependency - # Add `# pragma: NO COVER` because this test code will not run if all subfields are present at runtime - for subfield_to_delete in subfields_not_in_runtime: # pragma: NO COVER - field = subfield_to_delete.get("field") - field_repeated = subfield_to_delete.get("is_repeated") - subfield = subfield_to_delete.get("subfield") - if subfield: - if field_repeated: - for i in range(0, len(request_init["ssh_public_key"][field])): - del request_init["ssh_public_key"][field][i][subfield] - else: - del request_init["ssh_public_key"][field][subfield] - 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 = common.SshPublicKey( - key='key_value', - expiration_time_usec=2144, - fingerprint='fingerprint_value', - name='name_value', - ) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = common.SshPublicKey.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - response = client.update_ssh_public_key(request) - - # Establish that the response is the type that we expect. - assert isinstance(response, common.SshPublicKey) - assert response.key == 'key_value' - assert response.expiration_time_usec == 2144 - assert response.fingerprint == 'fingerprint_value' - assert response.name == 'name_value' - -def test_update_ssh_public_key_rest_use_cached_wrapped_rpc(): - # Clients should use _prep_wrapped_messages to create cached wrapped rpcs, - # instead of constructing them on each call - with mock.patch("google.api_core.gapic_v1.method.wrap_method") as wrapper_fn: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport="rest", - ) - - # Should wrap all calls on client creation - assert wrapper_fn.call_count > 0 - wrapper_fn.reset_mock() - - # Ensure method has been cached - assert client._transport.update_ssh_public_key in client._transport._wrapped_methods - - # Replace cached wrapped function with mock - mock_rpc = mock.Mock() - mock_rpc.return_value.name = "foo" # operation_request.operation in compute client(s) expect a string. - client._transport._wrapped_methods[client._transport.update_ssh_public_key] = mock_rpc - - request = {} - client.update_ssh_public_key(request) - - # Establish that the underlying gRPC stub method was called. - assert mock_rpc.call_count == 1 - - client.update_ssh_public_key(request) - - # Establish that a new wrapper was not created for this call - assert wrapper_fn.call_count == 0 - assert mock_rpc.call_count == 2 - - -def test_update_ssh_public_key_rest_required_fields(request_type=oslogin.UpdateSshPublicKeyRequest): - transport_class = transports.OsLoginServiceRestTransport - - request_init = {} - request_init["name"] = "" - request = request_type(**request_init) - pb_request = request_type.pb(request) - jsonified_request = json.loads(json_format.MessageToJson( - pb_request, - use_integers_for_enums=False - )) - - # verify fields with default values are dropped - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_ssh_public_key._get_unset_required_fields(jsonified_request) - jsonified_request.update(unset_fields) - - # verify required fields with default values are now present - - jsonified_request["name"] = 'name_value' - - unset_fields = transport_class(credentials=ga_credentials.AnonymousCredentials()).update_ssh_public_key._get_unset_required_fields(jsonified_request) - # Check that path parameters and body parameters are not mixing in. - assert not set(unset_fields) - set(("update_mask", )) - jsonified_request.update(unset_fields) - - # verify required fields with non-default values are left alone - assert "name" in jsonified_request - assert jsonified_request["name"] == 'name_value' - - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest', - ) - request = request_type(**request_init) - - # Designate an appropriate value for the returned response. - return_value = common.SshPublicKey() - # 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': "patch", - 'query_params': pb_request, - } - transcode_result['body'] = pb_request - transcode.return_value = transcode_result - - response_value = Response() - response_value.status_code = 200 - - # Convert return value to protobuf type - return_value = common.SshPublicKey.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - response = client.update_ssh_public_key(request) - - expected_params = [ - ('$alt', 'json;enum-encoding=int') - ] - actual_params = req.call_args.kwargs['params'] - assert expected_params == actual_params - - -def test_update_ssh_public_key_rest_unset_required_fields(): - transport = transports.OsLoginServiceRestTransport(credentials=ga_credentials.AnonymousCredentials) - - unset_fields = transport.update_ssh_public_key._get_unset_required_fields({}) - assert set(unset_fields) == (set(("updateMask", )) & set(("name", "sshPublicKey", ))) - - -@pytest.mark.parametrize("null_interceptor", [True, False]) -def test_update_ssh_public_key_rest_interceptors(null_interceptor): - transport = transports.OsLoginServiceRestTransport( - credentials=ga_credentials.AnonymousCredentials(), - interceptor=None if null_interceptor else transports.OsLoginServiceRestInterceptor(), - ) - client = OsLoginServiceClient(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.OsLoginServiceRestInterceptor, "post_update_ssh_public_key") as post, \ - mock.patch.object(transports.OsLoginServiceRestInterceptor, "pre_update_ssh_public_key") as pre: - pre.assert_not_called() - post.assert_not_called() - pb_message = oslogin.UpdateSshPublicKeyRequest.pb(oslogin.UpdateSshPublicKeyRequest()) - 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 = common.SshPublicKey.to_json(common.SshPublicKey()) - - request = oslogin.UpdateSshPublicKeyRequest() - metadata =[ - ("key", "val"), - ("cephalopod", "squid"), - ] - pre.return_value = request, metadata - post.return_value = common.SshPublicKey() - - client.update_ssh_public_key(request, metadata=[("key", "val"), ("cephalopod", "squid"),]) - - pre.assert_called_once() - post.assert_called_once() - - -def test_update_ssh_public_key_rest_bad_request(transport: str = 'rest', request_type=oslogin.UpdateSshPublicKeyRequest): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # send a request that will satisfy transcoding - request_init = {'name': 'users/sample1/sshPublicKeys/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_ssh_public_key(request) - - -def test_update_ssh_public_key_rest_flattened(): - client = OsLoginServiceClient( - 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 = common.SshPublicKey() - - # get arguments that satisfy an http rule for this method - sample_request = {'name': 'users/sample1/sshPublicKeys/sample2'} - - # get truthy value for each flattened field - mock_args = dict( - name='name_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - mock_args.update(sample_request) - - # Wrap the value into a proper Response obj - response_value = Response() - response_value.status_code = 200 - # Convert return value to protobuf type - return_value = common.SshPublicKey.pb(return_value) - json_return_value = json_format.MessageToJson(return_value) - response_value._content = json_return_value.encode('UTF-8') - req.return_value = response_value - - client.update_ssh_public_key(**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/v1/{name=users/*/sshPublicKeys/*}" % client.transport._host, args[1]) - - -def test_update_ssh_public_key_rest_flattened_error(transport: str = 'rest'): - client = OsLoginServiceClient( - 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_ssh_public_key( - oslogin.UpdateSshPublicKeyRequest(), - name='name_value', - ssh_public_key=common.SshPublicKey(key='key_value'), - update_mask=field_mask_pb2.FieldMask(paths=['paths_value']), - ) - - -def test_update_ssh_public_key_rest_error(): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport='rest' - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.OsLoginServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.OsLoginServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = OsLoginServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide an api_key and a transport instance. - transport = transports.OsLoginServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = OsLoginServiceClient( - client_options=options, - transport=transport, - ) - - # It is an error to provide an api_key and a credential. - options = client_options.ClientOptions() - options.api_key = "api_key" - with pytest.raises(ValueError): - client = OsLoginServiceClient( - client_options=options, - credentials=ga_credentials.AnonymousCredentials() - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.OsLoginServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = OsLoginServiceClient( - client_options={"scopes": ["1", "2"]}, - transport=transport, - ) - - -def test_transport_instance(): - # A client may be instantiated with a custom transport instance. - transport = transports.OsLoginServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - client = OsLoginServiceClient(transport=transport) - assert client.transport is transport - -def test_transport_get_channel(): - # A client may be instantiated with a custom transport instance. - transport = transports.OsLoginServiceGrpcTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.OsLoginServiceGrpcAsyncIOTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - -@pytest.mark.parametrize("transport_class", [ - transports.OsLoginServiceGrpcTransport, - transports.OsLoginServiceGrpcAsyncIOTransport, - transports.OsLoginServiceRestTransport, -]) -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 = OsLoginServiceClient.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 = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - ) - assert isinstance( - client.transport, - transports.OsLoginServiceGrpcTransport, - ) - -def test_os_login_service_base_transport_error(): - # Passing both a credentials object and credentials_file should raise an error - with pytest.raises(core_exceptions.DuplicateCredentialArgs): - transport = transports.OsLoginServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - credentials_file="credentials.json" - ) - - -def test_os_login_service_base_transport(): - # Instantiate the base transport. - with mock.patch('google.cloud.oslogin_v1.services.os_login_service.transports.OsLoginServiceTransport.__init__') as Transport: - Transport.return_value = None - transport = transports.OsLoginServiceTransport( - credentials=ga_credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - 'create_ssh_public_key', - 'delete_posix_account', - 'delete_ssh_public_key', - 'get_login_profile', - 'get_ssh_public_key', - 'import_ssh_public_key', - 'update_ssh_public_key', - ) - 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_os_login_service_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.oslogin_v1.services.os_login_service.transports.OsLoginServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - load_creds.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.OsLoginServiceTransport( - 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-platform.read-only', - 'https://www.googleapis.com/auth/compute', - 'https://www.googleapis.com/auth/compute.readonly', -), - quota_project_id="octopus", - ) - - -def test_os_login_service_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.oslogin_v1.services.os_login_service.transports.OsLoginServiceTransport._prep_wrapped_messages') as Transport: - Transport.return_value = None - adc.return_value = (ga_credentials.AnonymousCredentials(), None) - transport = transports.OsLoginServiceTransport() - adc.assert_called_once() - - -def test_os_login_service_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) - OsLoginServiceClient() - adc.assert_called_once_with( - scopes=None, - default_scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/cloud-platform.read-only', - 'https://www.googleapis.com/auth/compute', - 'https://www.googleapis.com/auth/compute.readonly', -), - quota_project_id=None, - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.OsLoginServiceGrpcTransport, - transports.OsLoginServiceGrpcAsyncIOTransport, - ], -) -def test_os_login_service_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-platform.read-only', 'https://www.googleapis.com/auth/compute', 'https://www.googleapis.com/auth/compute.readonly',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize( - "transport_class", - [ - transports.OsLoginServiceGrpcTransport, - transports.OsLoginServiceGrpcAsyncIOTransport, - transports.OsLoginServiceRestTransport, - ], -) -def test_os_login_service_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.OsLoginServiceGrpcTransport, grpc_helpers), - (transports.OsLoginServiceGrpcAsyncIOTransport, grpc_helpers_async) - ], -) -def test_os_login_service_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( - "oslogin.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-platform.read-only', - 'https://www.googleapis.com/auth/compute', - 'https://www.googleapis.com/auth/compute.readonly', -), - scopes=["1", "2"], - default_host="oslogin.googleapis.com", - ssl_credentials=None, - options=[ - ("grpc.max_send_message_length", -1), - ("grpc.max_receive_message_length", -1), - ], - ) - - -@pytest.mark.parametrize("transport_class", [transports.OsLoginServiceGrpcTransport, transports.OsLoginServiceGrpcAsyncIOTransport]) -def test_os_login_service_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_os_login_service_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.OsLoginServiceRestTransport ( - 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_os_login_service_host_no_port(transport_name): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='oslogin.googleapis.com'), - transport=transport_name, - ) - assert client.transport._host == ( - 'oslogin.googleapis.com:443' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://oslogin.googleapis.com' - ) - -@pytest.mark.parametrize("transport_name", [ - "grpc", - "grpc_asyncio", - "rest", -]) -def test_os_login_service_host_with_port(transport_name): - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='oslogin.googleapis.com:8000'), - transport=transport_name, - ) - assert client.transport._host == ( - 'oslogin.googleapis.com:8000' - if transport_name in ['grpc', 'grpc_asyncio'] - else 'https://oslogin.googleapis.com:8000' - ) - -@pytest.mark.parametrize("transport_name", [ - "rest", -]) -def test_os_login_service_client_transport_session_collision(transport_name): - creds1 = ga_credentials.AnonymousCredentials() - creds2 = ga_credentials.AnonymousCredentials() - client1 = OsLoginServiceClient( - credentials=creds1, - transport=transport_name, - ) - client2 = OsLoginServiceClient( - credentials=creds2, - transport=transport_name, - ) - session1 = client1.transport.create_ssh_public_key._session - session2 = client2.transport.create_ssh_public_key._session - assert session1 != session2 - session1 = client1.transport.delete_posix_account._session - session2 = client2.transport.delete_posix_account._session - assert session1 != session2 - session1 = client1.transport.delete_ssh_public_key._session - session2 = client2.transport.delete_ssh_public_key._session - assert session1 != session2 - session1 = client1.transport.get_login_profile._session - session2 = client2.transport.get_login_profile._session - assert session1 != session2 - session1 = client1.transport.get_ssh_public_key._session - session2 = client2.transport.get_ssh_public_key._session - assert session1 != session2 - session1 = client1.transport.import_ssh_public_key._session - session2 = client2.transport.import_ssh_public_key._session - assert session1 != session2 - session1 = client1.transport.update_ssh_public_key._session - session2 = client2.transport.update_ssh_public_key._session - assert session1 != session2 -def test_os_login_service_grpc_transport_channel(): - channel = grpc.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.OsLoginServiceGrpcTransport( - 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_os_login_service_grpc_asyncio_transport_channel(): - channel = aio.secure_channel('http://localhost/', grpc.local_channel_credentials()) - - # Check that channel is used if provided. - transport = transports.OsLoginServiceGrpcAsyncIOTransport( - 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.OsLoginServiceGrpcTransport, transports.OsLoginServiceGrpcAsyncIOTransport]) -def test_os_login_service_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.OsLoginServiceGrpcTransport, transports.OsLoginServiceGrpcAsyncIOTransport]) -def test_os_login_service_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_posix_account_path(): - user = "squid" - project = "clam" - expected = "users/{user}/projects/{project}".format(user=user, project=project, ) - actual = OsLoginServiceClient.posix_account_path(user, project) - assert expected == actual - - -def test_parse_posix_account_path(): - expected = { - "user": "whelk", - "project": "octopus", - } - path = OsLoginServiceClient.posix_account_path(**expected) - - # Check that the path construction is reversible. - actual = OsLoginServiceClient.parse_posix_account_path(path) - assert expected == actual - -def test_ssh_public_key_path(): - user = "oyster" - fingerprint = "nudibranch" - expected = "users/{user}/sshPublicKeys/{fingerprint}".format(user=user, fingerprint=fingerprint, ) - actual = OsLoginServiceClient.ssh_public_key_path(user, fingerprint) - assert expected == actual - - -def test_parse_ssh_public_key_path(): - expected = { - "user": "cuttlefish", - "fingerprint": "mussel", - } - path = OsLoginServiceClient.ssh_public_key_path(**expected) - - # Check that the path construction is reversible. - actual = OsLoginServiceClient.parse_ssh_public_key_path(path) - assert expected == actual - -def test_common_billing_account_path(): - billing_account = "winkle" - expected = "billingAccounts/{billing_account}".format(billing_account=billing_account, ) - actual = OsLoginServiceClient.common_billing_account_path(billing_account) - assert expected == actual - - -def test_parse_common_billing_account_path(): - expected = { - "billing_account": "nautilus", - } - path = OsLoginServiceClient.common_billing_account_path(**expected) - - # Check that the path construction is reversible. - actual = OsLoginServiceClient.parse_common_billing_account_path(path) - assert expected == actual - -def test_common_folder_path(): - folder = "scallop" - expected = "folders/{folder}".format(folder=folder, ) - actual = OsLoginServiceClient.common_folder_path(folder) - assert expected == actual - - -def test_parse_common_folder_path(): - expected = { - "folder": "abalone", - } - path = OsLoginServiceClient.common_folder_path(**expected) - - # Check that the path construction is reversible. - actual = OsLoginServiceClient.parse_common_folder_path(path) - assert expected == actual - -def test_common_organization_path(): - organization = "squid" - expected = "organizations/{organization}".format(organization=organization, ) - actual = OsLoginServiceClient.common_organization_path(organization) - assert expected == actual - - -def test_parse_common_organization_path(): - expected = { - "organization": "clam", - } - path = OsLoginServiceClient.common_organization_path(**expected) - - # Check that the path construction is reversible. - actual = OsLoginServiceClient.parse_common_organization_path(path) - assert expected == actual - -def test_common_project_path(): - project = "whelk" - expected = "projects/{project}".format(project=project, ) - actual = OsLoginServiceClient.common_project_path(project) - assert expected == actual - - -def test_parse_common_project_path(): - expected = { - "project": "octopus", - } - path = OsLoginServiceClient.common_project_path(**expected) - - # Check that the path construction is reversible. - actual = OsLoginServiceClient.parse_common_project_path(path) - assert expected == actual - -def test_common_location_path(): - project = "oyster" - location = "nudibranch" - expected = "projects/{project}/locations/{location}".format(project=project, location=location, ) - actual = OsLoginServiceClient.common_location_path(project, location) - assert expected == actual - - -def test_parse_common_location_path(): - expected = { - "project": "cuttlefish", - "location": "mussel", - } - path = OsLoginServiceClient.common_location_path(**expected) - - # Check that the path construction is reversible. - actual = OsLoginServiceClient.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.OsLoginServiceTransport, '_prep_wrapped_messages') as prep: - client = OsLoginServiceClient( - credentials=ga_credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info) - - with mock.patch.object(transports.OsLoginServiceTransport, '_prep_wrapped_messages') as prep: - transport_class = OsLoginServiceClient.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 = OsLoginServiceAsyncClient( - 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 = OsLoginServiceClient( - 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 = OsLoginServiceClient( - 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", [ - (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport), - (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport), -]) -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_TEMPLATE.format(UNIVERSE_DOMAIN=client._DEFAULT_UNIVERSE), - 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/packages/google-cloud-os-login/README.rst b/packages/google-cloud-os-login/README.rst index d2307da89516..f6dc1c1f2a0d 100644 --- a/packages/google-cloud-os-login/README.rst +++ b/packages/google-cloud-os-login/README.rst @@ -15,7 +15,7 @@ Python Client for Google Cloud OS Login .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-os-login.svg :target: https://pypi.org/project/google-cloud-os-login/ .. _Google Cloud OS Login: https://cloud.google.com/compute/docs/oslogin/ -.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/oslogin/latest +.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/oslogin/latest/summary_overview .. _Product Documentation: https://cloud.google.com/compute/docs/oslogin/ Quick Start diff --git a/packages/google-cloud-os-login/docs/index.rst b/packages/google-cloud-os-login/docs/index.rst index c18563cc44f9..85ac2194cb99 100644 --- a/packages/google-cloud-os-login/docs/index.rst +++ b/packages/google-cloud-os-login/docs/index.rst @@ -22,3 +22,8 @@ For a list of all ``google-cloud-os-login`` releases: :maxdepth: 2 CHANGELOG + +.. toctree:: + :hidden: + + summary_overview.md diff --git a/packages/google-cloud-os-login/docs/summary_overview.md b/packages/google-cloud-os-login/docs/summary_overview.md new file mode 100644 index 000000000000..726a45ced6ba --- /dev/null +++ b/packages/google-cloud-os-login/docs/summary_overview.md @@ -0,0 +1,22 @@ +[ +This is a templated file. Adding content to this file may result in it being +reverted. Instead, if you want to place additional content, create an +"overview_content.md" file in `docs/` directory. The Sphinx tool will +pick up on the content and merge the content. +]: # + +# Google Cloud OS Login API + +Overview of the APIs available for Google Cloud OS Login API. + +## All entries + +Classes, methods and properties & attributes for +Google Cloud OS Login API. + +[classes](https://cloud.google.com/python/docs/reference/oslogin/latest/summary_class.html) + +[methods](https://cloud.google.com/python/docs/reference/oslogin/latest/summary_method.html) + +[properties and +attributes](https://cloud.google.com/python/docs/reference/oslogin/latest/summary_property.html) diff --git a/packages/google-cloud-os-login/noxfile.py b/packages/google-cloud-os-login/noxfile.py index 1e6cd48d0529..67b7265f7586 100644 --- a/packages/google-cloud-os-login/noxfile.py +++ b/packages/google-cloud-os-login/noxfile.py @@ -160,14 +160,28 @@ def install_unittest_dependencies(session, *constraints): session.install("-e", ".", *constraints) -def default(session): +@nox.session(python=UNIT_TEST_PYTHON_VERSIONS) +@nox.parametrize( + "protobuf_implementation", + ["python", "upb", "cpp"], +) +def unit(session, protobuf_implementation): # Install all test dependencies, then install this package in-place. + if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12"): + session.skip("cpp implementation is not supported in python 3.11+") + constraints_path = str( CURRENT_DIRECTORY / "testing" / f"constraints-{session.python}.txt" ) install_unittest_dependencies(session, "-c", constraints_path) + # TODO(https://github.com/googleapis/synthtool/issues/1976): + # Remove the 'cpp' implementation once support for Protobuf 3.x is dropped. + # The 'cpp' implementation requires Protobuf<4. + if protobuf_implementation == "cpp": + session.install("protobuf<4") + # Run py.test against the unit tests. session.run( "py.test", @@ -181,15 +195,12 @@ def default(session): "--cov-fail-under=0", os.path.join("tests", "unit"), *session.posargs, + env={ + "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, + }, ) -@nox.session(python=UNIT_TEST_PYTHON_VERSIONS) -def unit(session): - """Run the unit test suite.""" - default(session) - - def install_systemtest_dependencies(session, *constraints): # Use pre-release gRPC for system tests. # Exclude version 1.52.0rc1 which has a known issue. @@ -358,9 +369,16 @@ def docfx(session): @nox.session(python="3.12") -def prerelease_deps(session): +@nox.parametrize( + "protobuf_implementation", + ["python", "upb", "cpp"], +) +def prerelease_deps(session, protobuf_implementation): """Run all tests with prerelease versions of dependencies installed.""" + if protobuf_implementation == "cpp" and session.python in ("3.11", "3.12"): + session.skip("cpp implementation is not supported in python 3.11+") + # Install all dependencies session.install("-e", ".[all, tests, tracing]") unit_deps_all = UNIT_TEST_STANDARD_DEPENDENCIES + UNIT_TEST_EXTERNAL_DEPENDENCIES @@ -397,9 +415,9 @@ def prerelease_deps(session): "protobuf", # dependency of grpc "six", + "grpc-google-iam-v1", "googleapis-common-protos", - # Exclude version 1.52.0rc1 which has a known issue. See https://github.com/grpc/grpc/issues/32163 - "grpcio!=1.52.0rc1", + "grpcio", "grpcio-status", "google-api-core", "google-auth", @@ -425,4 +443,10 @@ def prerelease_deps(session): session.run("python", "-c", "import grpc; print(grpc.__version__)") session.run("python", "-c", "import google.auth; print(google.auth.__version__)") - session.run("py.test", "tests/unit") + session.run( + "py.test", + "tests/unit", + env={ + "PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION": protobuf_implementation, + }, + )