From 5a7c38c054a0a4ac29f418ad36d6f30026331c38 Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Tue, 11 May 2021 22:55:24 -0400 Subject: [PATCH 1/3] chore: migrate to owl bot --- .github/.OwlBot.lock.yaml | 4 ++ .github/.OwlBot.yaml | 29 ++++++++ synth.py => owlbot.py | 30 +++------ synth.metadata | 137 -------------------------------------- 4 files changed, 43 insertions(+), 157 deletions(-) create mode 100644 .github/.OwlBot.lock.yaml create mode 100644 .github/.OwlBot.yaml rename synth.py => owlbot.py (64%) delete mode 100644 synth.metadata diff --git a/.github/.OwlBot.lock.yaml b/.github/.OwlBot.lock.yaml new file mode 100644 index 0000000..d49860b --- /dev/null +++ b/.github/.OwlBot.lock.yaml @@ -0,0 +1,4 @@ +docker: + digest: sha256:457583330eec64daa02aeb7a72a04d33e7be2428f646671ce4045dcbc0191b1e + image: gcr.io/repo-automation-bots/owlbot-python:latest + diff --git a/.github/.OwlBot.yaml b/.github/.OwlBot.yaml new file mode 100644 index 0000000..49910b1 --- /dev/null +++ b/.github/.OwlBot.yaml @@ -0,0 +1,29 @@ +# Copyright 2021 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +docker: + image: gcr.io/repo-automation-bots/owlbot-python:latest + +deep-remove-regex: + - /owl-bot-staging + +deep-preserve-regex: + - /owl-bot-staging/v1beta + +deep-copy-regex: + - source: /google/cloud/oslogin/(v.*)/.*-py/(.*) + dest: /owl-bot-staging/$1/$2 + +begin-after-commit-hash: b06c9034cfcbce180ba732d03be6526e5c8ea1bc + diff --git a/synth.py b/owlbot.py similarity index 64% rename from synth.py rename to owlbot.py index 40f7a58..5b442b5 100644 --- a/synth.py +++ b/owlbot.py @@ -16,31 +16,21 @@ import synthtool as s from synthtool import gcp -gapic = gcp.GAPICBazel() common = gcp.CommonTemplates() -excludes = ["README.rst", "setup.py", "nox*.py", "docs/index.rst"] -# ---------------------------------------------------------------------------- -# Generate oslogin GAPIC layer -# ---------------------------------------------------------------------------- -library = gapic.py_library( - service="oslogin", - version="v1", - bazel_target="//google/cloud/oslogin/v1:oslogin-v1-py", - include_protos=True, -) - -s.move(library / "google/cloud/oslogin_v1") - -s.move(library / "google/cloud/oslogin", excludes=[library / "google/cloud/oslogin/common/**/*"]) -s.move(library / "google/cloud/oslogin/common", "google/cloud/oslogin_v1/common", excludes=[library / "google/cloud/oslogin/common/services"]) +default_version = "v1" -s.move(library / "tests/unit/gapic/oslogin_v1") +for library in s.get_staging_dirs(default_version): + s.move(library / f"google/cloud/oslogin_{library.name}") + s.move(library / "google/cloud/oslogin", excludes=[ "common/**/*"]) + s.move(library / "google/cloud/oslogin/common", f"google/cloud/oslogin_{library.name}/common", excludes=["services"]) + s.move(library / f"tests/unit/gapic/oslogin_{library.name}") + s.move(library / f"scripts/fixup_oslogin_{library.name}_keywords.py") + s.move(library / "docs", excludes=["index.rst", "common"]) + s.move(library / f"docs/common", f"docs/oslogin_{library.name}/common", excludes=["services.rst"]) -s.move(library / "scripts/fixup_oslogin_v1_keywords.py") +s.remove_staging_dirs() -s.move(library / "docs", excludes=[library / "docs/index.rst", library / "docs/common"]) -s.move(library / "docs/common", "docs/oslogin_v1/common", excludes=[library / "docs/common/services.rst"]) s.replace( "docs/oslogin_v1/common/types.rst", "google.cloud.oslogin.common.types", diff --git a/synth.metadata b/synth.metadata deleted file mode 100644 index 5e436bd..0000000 --- a/synth.metadata +++ /dev/null @@ -1,137 +0,0 @@ -{ - "sources": [ - { - "git": { - "name": ".", - "remote": "https://github.com/googleapis/python-oslogin.git", - "sha": "a721d8e7d940749f6267990d152465dd8bd268d4" - } - }, - { - "git": { - "name": "googleapis", - "remote": "https://github.com/googleapis/googleapis.git", - "sha": "915925089600094e72e4bfa8cf586c170e6b7109", - "internalRef": "366152684" - } - }, - { - "git": { - "name": "synthtool", - "remote": "https://github.com/googleapis/synthtool.git", - "sha": "043cc620d6a6111816d9e09f2a97208565fde958" - } - } - ], - "destinations": [ - { - "client": { - "source": "googleapis", - "apiName": "oslogin", - "apiVersion": "v1", - "language": "python", - "generator": "bazel" - } - } - ], - "generatedFiles": [ - ".flake8", - ".github/CONTRIBUTING.md", - ".github/ISSUE_TEMPLATE/bug_report.md", - ".github/ISSUE_TEMPLATE/feature_request.md", - ".github/ISSUE_TEMPLATE/support_request.md", - ".github/PULL_REQUEST_TEMPLATE.md", - ".github/header-checker-lint.yml", - ".github/release-please.yml", - ".github/snippet-bot.yml", - ".gitignore", - ".kokoro/build.sh", - ".kokoro/continuous/common.cfg", - ".kokoro/continuous/continuous.cfg", - ".kokoro/docker/docs/Dockerfile", - ".kokoro/docker/docs/fetch_gpg_keys.sh", - ".kokoro/docs/common.cfg", - ".kokoro/docs/docs-presubmit.cfg", - ".kokoro/docs/docs.cfg", - ".kokoro/populate-secrets.sh", - ".kokoro/presubmit/common.cfg", - ".kokoro/presubmit/presubmit.cfg", - ".kokoro/publish-docs.sh", - ".kokoro/release.sh", - ".kokoro/release/common.cfg", - ".kokoro/release/release.cfg", - ".kokoro/samples/lint/common.cfg", - ".kokoro/samples/lint/continuous.cfg", - ".kokoro/samples/lint/periodic.cfg", - ".kokoro/samples/lint/presubmit.cfg", - ".kokoro/samples/python3.6/common.cfg", - ".kokoro/samples/python3.6/continuous.cfg", - ".kokoro/samples/python3.6/periodic-head.cfg", - ".kokoro/samples/python3.6/periodic.cfg", - ".kokoro/samples/python3.6/presubmit.cfg", - ".kokoro/samples/python3.7/common.cfg", - ".kokoro/samples/python3.7/continuous.cfg", - ".kokoro/samples/python3.7/periodic-head.cfg", - ".kokoro/samples/python3.7/periodic.cfg", - ".kokoro/samples/python3.7/presubmit.cfg", - ".kokoro/samples/python3.8/common.cfg", - ".kokoro/samples/python3.8/continuous.cfg", - ".kokoro/samples/python3.8/periodic-head.cfg", - ".kokoro/samples/python3.8/periodic.cfg", - ".kokoro/samples/python3.8/presubmit.cfg", - ".kokoro/test-samples-against-head.sh", - ".kokoro/test-samples-impl.sh", - ".kokoro/test-samples.sh", - ".kokoro/trampoline.sh", - ".kokoro/trampoline_v2.sh", - ".pre-commit-config.yaml", - ".trampolinerc", - "CODE_OF_CONDUCT.md", - "CONTRIBUTING.rst", - "LICENSE", - "MANIFEST.in", - "docs/_static/custom.css", - "docs/_templates/layout.html", - "docs/conf.py", - "docs/multiprocessing.rst", - "docs/oslogin_v1/common/types.rst", - "docs/oslogin_v1/os_login_service.rst", - "docs/oslogin_v1/services.rst", - "docs/oslogin_v1/types.rst", - "google/cloud/oslogin/__init__.py", - "google/cloud/oslogin/py.typed", - "google/cloud/oslogin_v1/__init__.py", - "google/cloud/oslogin_v1/common/__init__.py", - "google/cloud/oslogin_v1/common/py.typed", - "google/cloud/oslogin_v1/common/types/__init__.py", - "google/cloud/oslogin_v1/common/types/common.py", - "google/cloud/oslogin_v1/proto/oslogin.proto", - "google/cloud/oslogin_v1/py.typed", - "google/cloud/oslogin_v1/services/__init__.py", - "google/cloud/oslogin_v1/services/os_login_service/__init__.py", - "google/cloud/oslogin_v1/services/os_login_service/async_client.py", - "google/cloud/oslogin_v1/services/os_login_service/client.py", - "google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py", - "google/cloud/oslogin_v1/services/os_login_service/transports/base.py", - "google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py", - "google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py", - "google/cloud/oslogin_v1/types/__init__.py", - "google/cloud/oslogin_v1/types/oslogin.py", - "noxfile.py", - "renovate.json", - "samples/AUTHORING_GUIDE.md", - "samples/CONTRIBUTING.md", - "scripts/decrypt-secrets.sh", - "scripts/fixup_oslogin_v1_keywords.py", - "scripts/readme-gen/readme_gen.py", - "scripts/readme-gen/templates/README.tmpl.rst", - "scripts/readme-gen/templates/auth.tmpl.rst", - "scripts/readme-gen/templates/auth_api_key.tmpl.rst", - "scripts/readme-gen/templates/install_deps.tmpl.rst", - "scripts/readme-gen/templates/install_portaudio.tmpl.rst", - "setup.cfg", - "testing/.gitignore", - "tests/unit/gapic/oslogin_v1/__init__.py", - "tests/unit/gapic/oslogin_v1/test_os_login_service.py" - ] -} \ No newline at end of file From c67cc66d4a3b8dc35eb782f3fbf826ac95998c0a Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Tue, 11 May 2021 22:56:47 -0400 Subject: [PATCH 2/3] chore: copy files from googleapis-gen b06c9034cfcbce180ba732d03be6526e5c8ea1bc --- owl-bot-staging/v1/MANIFEST.in | 2 + owl-bot-staging/v1/README.rst | 49 + owl-bot-staging/v1/docs/common/services.rst | 4 + owl-bot-staging/v1/docs/common/types.rst | 7 + owl-bot-staging/v1/docs/conf.py | 378 +++ owl-bot-staging/v1/docs/index.rst | 7 + .../v1/docs/oslogin_v1/os_login_service.rst | 6 + .../v1/docs/oslogin_v1/services.rst | 6 + owl-bot-staging/v1/docs/oslogin_v1/types.rst | 7 + .../v1/google/cloud/oslogin/__init__.py | 40 + .../google/cloud/oslogin/common/__init__.py | 27 + .../v1/google/cloud/oslogin/common/py.typed | 2 + .../cloud/oslogin/common/services/__init__.py | 16 + .../cloud/oslogin/common/types/__init__.py | 28 + .../cloud/oslogin/common/types/common.py | 125 + .../v1/google/cloud/oslogin/py.typed | 2 + .../v1/google/cloud/oslogin_v1/__init__.py | 39 + .../v1/google/cloud/oslogin_v1/py.typed | 2 + .../cloud/oslogin_v1/services/__init__.py | 16 + .../services/os_login_service/__init__.py | 24 + .../services/os_login_service/async_client.py | 738 ++++++ .../services/os_login_service/client.py | 865 ++++++ .../os_login_service/transports/__init__.py | 35 + .../os_login_service/transports/base.py | 260 ++ .../os_login_service/transports/grpc.py | 388 +++ .../transports/grpc_asyncio.py | 393 +++ .../google/cloud/oslogin_v1/types/__init__.py | 38 + .../google/cloud/oslogin_v1/types/oslogin.py | 196 ++ owl-bot-staging/v1/mypy.ini | 3 + owl-bot-staging/v1/noxfile.py | 72 + .../v1/scripts/fixup_common_keywords.py | 178 ++ .../v1/scripts/fixup_oslogin_v1_keywords.py | 184 ++ owl-bot-staging/v1/setup.py | 55 + .../v1/tests/unit/gapic/common/__init__.py | 17 + .../tests/unit/gapic/oslogin_v1/__init__.py | 17 + .../gapic/oslogin_v1/test_os_login_service.py | 2347 +++++++++++++++++ 36 files changed, 6573 insertions(+) create mode 100644 owl-bot-staging/v1/MANIFEST.in create mode 100644 owl-bot-staging/v1/README.rst create mode 100644 owl-bot-staging/v1/docs/common/services.rst create mode 100644 owl-bot-staging/v1/docs/common/types.rst create mode 100644 owl-bot-staging/v1/docs/conf.py create mode 100644 owl-bot-staging/v1/docs/index.rst create mode 100644 owl-bot-staging/v1/docs/oslogin_v1/os_login_service.rst create mode 100644 owl-bot-staging/v1/docs/oslogin_v1/services.rst create mode 100644 owl-bot-staging/v1/docs/oslogin_v1/types.rst create mode 100644 owl-bot-staging/v1/google/cloud/oslogin/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin/common/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin/common/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/oslogin/common/services/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin/common/types/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin/common/types/common.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/py.typed create mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/client.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/types/__init__.py create mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/types/oslogin.py create mode 100644 owl-bot-staging/v1/mypy.ini create mode 100644 owl-bot-staging/v1/noxfile.py create mode 100644 owl-bot-staging/v1/scripts/fixup_common_keywords.py create mode 100644 owl-bot-staging/v1/scripts/fixup_oslogin_v1_keywords.py create mode 100644 owl-bot-staging/v1/setup.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/common/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/__init__.py create mode 100644 owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in new file mode 100644 index 0000000..8fc658a --- /dev/null +++ b/owl-bot-staging/v1/MANIFEST.in @@ -0,0 +1,2 @@ +recursive-include google/cloud/oslogin/common *.py +recursive-include google/cloud/oslogin/common *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst new file mode 100644 index 0000000..0ceb83d --- /dev/null +++ b/owl-bot-staging/v1/README.rst @@ -0,0 +1,49 @@ +Python Client for Google Cloud Oslogin Common 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 Common 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/v1/docs/common/services.rst b/owl-bot-staging/v1/docs/common/services.rst new file mode 100644 index 0000000..50d1192 --- /dev/null +++ b/owl-bot-staging/v1/docs/common/services.rst @@ -0,0 +1,4 @@ +Services for Google Cloud Oslogin Common API +============================================= +.. toctree:: + :maxdepth: 2 diff --git a/owl-bot-staging/v1/docs/common/types.rst b/owl-bot-staging/v1/docs/common/types.rst new file mode 100644 index 0000000..9aa70cd --- /dev/null +++ b/owl-bot-staging/v1/docs/common/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Oslogin Common API +========================================== + +.. automodule:: google.cloud.oslogin.common.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py new file mode 100644 index 0000000..c8dad41 --- /dev/null +++ b/owl-bot-staging/v1/docs/conf.py @@ -0,0 +1,378 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +# +# google-cloud-oslogin-common 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 = "1.6.3" + +# 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 master toctree document. +master_doc = "index" + +# General information about the project. +project = u"google-cloud-oslogin-common" +copyright = u"2020, Google, LLC" +author = u"Google APIs" # TODO: autogenerate this bit + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The full version, including alpha/beta/rc tags. +release = __version__ +# The short X.Y version. +version = ".".join(release.split(".")[0:2]) + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ["_build"] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = "sphinx" + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = "alabaster" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + "description": "Google Cloud Oslogin 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-oslogin-common-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 = [ + ( + master_doc, + "google-cloud-oslogin-common.tex", + u"google-cloud-oslogin-common 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 = [ + ( + master_doc, + "google-cloud-oslogin-common", + u"Google Cloud Oslogin Common 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 = [ + ( + master_doc, + "google-cloud-oslogin-common", + u"google-cloud-oslogin-common Documentation", + author, + "google-cloud-oslogin-common", + "GAPIC library for Google Cloud Oslogin Common 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/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst new file mode 100644 index 0000000..fbec834 --- /dev/null +++ b/owl-bot-staging/v1/docs/index.rst @@ -0,0 +1,7 @@ +API Reference +------------- +.. toctree:: + :maxdepth: 2 + + common/services + common/types diff --git a/owl-bot-staging/v1/docs/oslogin_v1/os_login_service.rst b/owl-bot-staging/v1/docs/oslogin_v1/os_login_service.rst new file mode 100644 index 0000000..588b1fb --- /dev/null +++ b/owl-bot-staging/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/v1/docs/oslogin_v1/services.rst b/owl-bot-staging/v1/docs/oslogin_v1/services.rst new file mode 100644 index 0000000..10a7155 --- /dev/null +++ b/owl-bot-staging/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/v1/docs/oslogin_v1/types.rst b/owl-bot-staging/v1/docs/oslogin_v1/types.rst new file mode 100644 index 0000000..202b5bb --- /dev/null +++ b/owl-bot-staging/v1/docs/oslogin_v1/types.rst @@ -0,0 +1,7 @@ +Types for Google Cloud Oslogin v1 API +===================================== + +.. automodule:: google.cloud.oslogin_v1.types + :members: + :undoc-members: + :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/oslogin/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin/__init__.py new file mode 100644 index 0000000..6b30081 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin/__init__.py @@ -0,0 +1,40 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from google.cloud.oslogin_v1.services.os_login_service.async_client import OsLoginServiceAsyncClient +from google.cloud.oslogin_v1.services.os_login_service.client import OsLoginServiceClient +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__ = ( + 'DeletePosixAccountRequest', + 'DeleteSshPublicKeyRequest', + 'GetLoginProfileRequest', + 'GetSshPublicKeyRequest', + 'ImportSshPublicKeyRequest', + 'ImportSshPublicKeyResponse', + 'LoginProfile', + 'OsLoginServiceAsyncClient', + 'OsLoginServiceClient', + 'UpdateSshPublicKeyRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/oslogin/common/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin/common/__init__.py new file mode 100644 index 0000000..f50a487 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin/common/__init__.py @@ -0,0 +1,27 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .types.common import OperatingSystemType +from .types.common import PosixAccount +from .types.common import SshPublicKey + + +__all__ = ( + 'OperatingSystemType', + 'SshPublicKey', +'PosixAccount', +) diff --git a/owl-bot-staging/v1/google/cloud/oslogin/common/py.typed b/owl-bot-staging/v1/google/cloud/oslogin/common/py.typed new file mode 100644 index 0000000..5f0cbe7 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin/common/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-oslogin-common package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/oslogin/common/services/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin/common/services/__init__.py new file mode 100644 index 0000000..42ffdf2 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin/common/services/__init__.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/google/cloud/oslogin/common/types/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin/common/types/__init__.py new file mode 100644 index 0000000..8de3149 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin/common/types/__init__.py @@ -0,0 +1,28 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .common import ( + PosixAccount, + SshPublicKey, + OperatingSystemType, +) + +__all__ = ( + 'PosixAccount', + 'SshPublicKey', + 'OperatingSystemType', +) diff --git a/owl-bot-staging/v1/google/cloud/oslogin/common/types/common.py b/owl-bot-staging/v1/google/cloud/oslogin/common/types/common.py new file mode 100644 index 0000000..b673601 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin/common/types/common.py @@ -0,0 +1,125 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import proto # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.oslogin.common', + manifest={ + 'OperatingSystemType', + 'PosixAccount', + 'SshPublicKey', + }, +) + + +class OperatingSystemType(proto.Enum): + r"""The operating system options for account entries.""" + OPERATING_SYSTEM_TYPE_UNSPECIFIED = 0 + LINUX = 1 + WINDOWS = 2 + + +class PosixAccount(proto.Message): + r"""The POSIX account information associated with a Google + account. + + Attributes: + primary (bool): + Only one POSIX account can be marked as + primary. + username (str): + The username of the POSIX account. + uid (int): + The user ID. + gid (int): + The default group ID. + home_directory (str): + The path to the home directory for this + account. + shell (str): + The path to the logic shell for this account. + gecos (str): + The GECOS (user information) entry for this + account. + system_id (str): + System identifier for which account the + username or uid applies to. By default, the + empty value is used. + account_id (str): + Output only. A POSIX account identifier. + operating_system_type (google.cloud.oslogin.common.types.OperatingSystemType): + The operating system type where this account + applies. + name (str): + Output only. The canonical resource name. + """ + + primary = proto.Field(proto.BOOL, number=1) + + username = proto.Field(proto.STRING, number=2) + + uid = proto.Field(proto.INT64, number=3) + + gid = proto.Field(proto.INT64, number=4) + + home_directory = proto.Field(proto.STRING, number=5) + + shell = proto.Field(proto.STRING, number=6) + + gecos = proto.Field(proto.STRING, number=7) + + system_id = proto.Field(proto.STRING, number=8) + + account_id = proto.Field(proto.STRING, number=9) + + operating_system_type = proto.Field(proto.ENUM, number=10, + enum='OperatingSystemType', + ) + + name = proto.Field(proto.STRING, number=11) + + +class SshPublicKey(proto.Message): + r"""The SSH public key information associated with a Google + account. + + Attributes: + key (str): + Public key text in SSH format, defined by RFC4253 section + 6.6. + expiration_time_usec (int): + An expiration time in microseconds since + epoch. + fingerprint (str): + Output only. The SHA-256 fingerprint of the + SSH public key. + name (str): + Output only. The canonical resource name. + """ + + key = proto.Field(proto.STRING, number=1) + + expiration_time_usec = proto.Field(proto.INT64, number=2) + + fingerprint = proto.Field(proto.STRING, number=3) + + name = proto.Field(proto.STRING, number=4) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/oslogin/py.typed b/owl-bot-staging/v1/google/cloud/oslogin/py.typed new file mode 100644 index 0000000..825d05f --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-oslogin package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/__init__.py new file mode 100644 index 0000000..ce63332 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin_v1/__init__.py @@ -0,0 +1,39 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .services.os_login_service import OsLoginServiceClient +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__ = ( + 'DeletePosixAccountRequest', + 'DeleteSshPublicKeyRequest', + 'GetLoginProfileRequest', + 'GetSshPublicKeyRequest', + 'ImportSshPublicKeyRequest', + 'ImportSshPublicKeyResponse', + 'LoginProfile', + 'UpdateSshPublicKeyRequest', +'OsLoginServiceClient', +) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/py.typed b/owl-bot-staging/v1/google/cloud/oslogin_v1/py.typed new file mode 100644 index 0000000..825d05f --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin_v1/py.typed @@ -0,0 +1,2 @@ +# Marker file for PEP 561. +# The google-cloud-oslogin package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/__init__.py new file mode 100644 index 0000000..42ffdf2 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/__init__.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py new file mode 100644 index 0000000..71afda0 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py @@ -0,0 +1,24 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .client import OsLoginServiceClient +from .async_client import OsLoginServiceAsyncClient + +__all__ = ( + 'OsLoginServiceClient', + 'OsLoginServiceAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py new file mode 100644 index 0000000..66d1c30 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py @@ -0,0 +1,738 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from collections import OrderedDict +import functools +import re +from typing import Dict, Sequence, Tuple, Type, Union +import pkg_resources + +import google.api_core.client_options as ClientOptions # type: ignore +from google.api_core import exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials # type: ignore +from google.oauth2 import service_account # type: ignore + +from google.cloud.oslogin.common import common_pb2 as common # type: ignore +from google.cloud.oslogin_v1.types import oslogin +from google.protobuf import field_mask_pb2 as field_mask # 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 + + DEFAULT_ENDPOINT = OsLoginServiceClient.DEFAULT_ENDPOINT + DEFAULT_MTLS_ENDPOINT = OsLoginServiceClient.DEFAULT_MTLS_ENDPOINT + + 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 + + @property + def transport(self) -> OsLoginServiceTransport: + """Return the transport used by the client instance. + + Returns: + OsLoginServiceTransport: The transport used by the client instance. + """ + return self._client.transport + + get_transport_class = functools.partial(type(OsLoginServiceClient).get_transport_class, type(OsLoginServiceClient)) + + def __init__(self, *, + credentials: credentials.Credentials = None, + transport: Union[str, OsLoginServiceTransport] = 'grpc_asyncio', + client_options: ClientOptions = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate 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 (Union[str, ~.OsLoginServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (ClientOptions): Custom options for the client. It + won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + """ + + self._client = OsLoginServiceClient( + credentials=credentials, + transport=transport, + client_options=client_options, + client_info=client_info, + + ) + + async def delete_posix_account(self, + request: oslogin.DeletePosixAccountRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a POSIX account. + + Args: + request (:class:`google.cloud.oslogin_v1.types.DeletePosixAccountRequest`): + 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.Retry): Designation of what errors, if any, + should be 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. + # Sanity 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.') + + 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 = gapic_v1.method_async.wrap_method( + self._client._transport.delete_posix_account, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + exceptions.DeadlineExceeded, + exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('name', request.name), + )), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def delete_ssh_public_key(self, + request: oslogin.DeleteSshPublicKeyRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes an SSH public key. + + Args: + request (:class:`google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest`): + 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.Retry): Designation of what errors, if any, + should be 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. + # Sanity 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.') + + 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 = gapic_v1.method_async.wrap_method( + self._client._transport.delete_ssh_public_key, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + exceptions.DeadlineExceeded, + exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('name', request.name), + )), + ) + + # Send the request. + await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + async def get_login_profile(self, + request: oslogin.GetLoginProfileRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> oslogin.LoginProfile: + r"""Retrieves the profile information used for logging in + to a virtual machine on Google Compute Engine. + + Args: + request (:class:`google.cloud.oslogin_v1.types.GetLoginProfileRequest`): + 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.Retry): Designation of what errors, if any, + should be retried. + 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. + # Sanity 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.') + + 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 = gapic_v1.method_async.wrap_method( + self._client._transport.get_login_profile, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + exceptions.DeadlineExceeded, + exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('name', request.name), + )), + ) + + # 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: oslogin.GetSshPublicKeyRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> common.SshPublicKey: + r"""Retrieves an SSH public key. + + Args: + request (:class:`google.cloud.oslogin_v1.types.GetSshPublicKeyRequest`): + 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.Retry): Designation of what errors, if any, + should be retried. + 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.common_pb2.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + # Create or coerce a protobuf request object. + # Sanity 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.') + + 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 = gapic_v1.method_async.wrap_method( + self._client._transport.get_ssh_public_key, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + exceptions.DeadlineExceeded, + exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('name', request.name), + )), + ) + + # 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: oslogin.ImportSshPublicKeyRequest = None, + *, + parent: str = None, + ssh_public_key: common.SshPublicKey = None, + project_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + 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. + + Args: + request (:class:`google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest`): + 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.common_pb2.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.Retry): Designation of what errors, if any, + should be retried. + 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. + # Sanity 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.') + + 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 = gapic_v1.method_async.wrap_method( + self._client._transport.import_ssh_public_key, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + exceptions.DeadlineExceeded, + exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('parent', request.parent), + )), + ) + + # 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: oslogin.UpdateSshPublicKeyRequest = None, + *, + name: str = None, + ssh_public_key: common.SshPublicKey = None, + update_mask: field_mask.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> common.SshPublicKey: + r"""Updates an SSH public key and returns the profile + information. This method supports patch semantics. + + Args: + request (:class:`google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest`): + 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.common_pb2.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.Retry): Designation of what errors, if any, + should be retried. + 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.common_pb2.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + # Create or coerce a protobuf request object. + # Sanity 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.') + + 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 = gapic_v1.method_async.wrap_method( + self._client._transport.update_ssh_public_key, + default_retry=retries.Retry( + initial=0.1, + maximum=60.0, + multiplier=1.3, + predicate=retries.if_exception_type( + exceptions.DeadlineExceeded, + exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=DEFAULT_CLIENT_INFO, + ) + + # Certain fields should be provided within the metadata header; + # add these here. + metadata = tuple(metadata) + ( + gapic_v1.routing_header.to_grpc_metadata(( + ('name', request.name), + )), + ) + + # Send the request. + response = await rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-oslogin', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + 'OsLoginServiceAsyncClient', +) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/client.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/client.py new file mode 100644 index 0000000..05c097a --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/client.py @@ -0,0 +1,865 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from collections import OrderedDict +from distutils import util +import os +import re +from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union +import pkg_resources + +from google.api_core import client_options as client_options_lib # type: ignore +from google.api_core import exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import 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 + +from google.cloud.oslogin.common import common_pb2 as common # type: ignore +from google.cloud.oslogin_v1.types import oslogin +from google.protobuf import field_mask_pb2 as field_mask # type: ignore + +from .transports.base import OsLoginServiceTransport, DEFAULT_CLIENT_INFO +from .transports.grpc import OsLoginServiceGrpcTransport +from .transports.grpc_asyncio import OsLoginServiceGrpcAsyncIOTransport + + +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 + + def get_transport_class(cls, + label: str = None, + ) -> Type[OsLoginServiceTransport]: + """Return 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): + """Convert api endpoint to mTLS endpoint. + Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to + "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. + Args: + api_endpoint (Optional[str]): the api endpoint to convert. + Returns: + str: converted mTLS api endpoint. + """ + if not api_endpoint: + return api_endpoint + + mtls_endpoint_re = re.compile( + r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" + ) + + m = mtls_endpoint_re.match(api_endpoint) + name, mtls, sandbox, googledomain = m.groups() + if mtls or not googledomain: + return api_endpoint + + if sandbox: + return api_endpoint.replace( + "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" + ) + + return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") + + DEFAULT_ENDPOINT = 'oslogin.googleapis.com' + DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore + DEFAULT_ENDPOINT + ) + + @classmethod + def from_service_account_info(cls, info: dict, *args, **kwargs): + """Creates an instance of this client using the provided credentials info. + + Args: + info (dict): The service account private key info. + args: Additional arguments to pass to the constructor. + kwargs: Additional arguments to pass to the constructor. + + Returns: + 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: + """Return 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: + """Return 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]: + """Parse 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: + """Return 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]: + """Parse 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: + """Return 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: + """Return 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: + """Return 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: + """Return 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: + """Return 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 {} + + def __init__(self, *, + credentials: Optional[credentials.Credentials] = None, + transport: Union[str, OsLoginServiceTransport, None] = None, + client_options: Optional[client_options_lib.ClientOptions] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate 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 (Union[str, OsLoginServiceTransport]): The + transport to use. If set to None, a transport is chosen + automatically. + client_options (google.api_core.client_options.ClientOptions): Custom options for the + client. It won't take effect if a ``transport`` instance is provided. + (1) The ``api_endpoint`` property can be used to override the + default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT + environment variable can also be used to override the endpoint: + "always" (always use the default mTLS endpoint), "never" (always + use the default regular endpoint) and "auto" (auto switch to the + default mTLS endpoint if client certificate is present, this is + the default value). However, the ``api_endpoint`` property takes + precedence if provided. + (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable + is "true", then the ``client_cert_source`` property can be used + to provide client certificate for mutual TLS transport. If + not provided, the default SSL client certificate will be used if + present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not + set, no client certificate will be used. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + """ + if isinstance(client_options, dict): + client_options = client_options_lib.from_dict(client_options) + if client_options is None: + client_options = client_options_lib.ClientOptions() + + # Create SSL credentials for mutual TLS if needed. + use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) + + client_cert_source_func = None + is_mtls = False + if use_client_cert: + if client_options.client_cert_source: + is_mtls = True + client_cert_source_func = client_options.client_cert_source + else: + is_mtls = mtls.has_default_client_cert_source() + client_cert_source_func = mtls.default_client_cert_source() if is_mtls else None + + # Figure out which api endpoint to use. + if client_options.api_endpoint is not None: + api_endpoint = client_options.api_endpoint + else: + use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") + if use_mtls_env == "never": + api_endpoint = self.DEFAULT_ENDPOINT + elif use_mtls_env == "always": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT + elif use_mtls_env == "auto": + api_endpoint = self.DEFAULT_MTLS_ENDPOINT if is_mtls else self.DEFAULT_ENDPOINT + else: + raise MutualTLSChannelError( + "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted values: never, auto, always" + ) + + # Save or instantiate the transport. + # Ordinarily, we provide the transport, but allowing a custom transport + # instance provides an extensibility point for unusual situations. + if isinstance(transport, OsLoginServiceTransport): + # transport is a OsLoginServiceTransport instance. + if credentials or client_options.credentials_file: + raise ValueError('When providing a transport instance, ' + 'provide its credentials directly.') + if client_options.scopes: + raise ValueError( + "When providing a transport instance, " + "provide its scopes directly." + ) + self._transport = transport + else: + Transport = type(self).get_transport_class(transport) + self._transport = Transport( + credentials=credentials, + credentials_file=client_options.credentials_file, + host=api_endpoint, + scopes=client_options.scopes, + client_cert_source_for_mtls=client_cert_source_func, + quota_project_id=client_options.quota_project_id, + client_info=client_info, + ) + + def delete_posix_account(self, + request: oslogin.DeletePosixAccountRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes a POSIX account. + + Args: + request (google.cloud.oslogin_v1.types.DeletePosixAccountRequest): + 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. + # Sanity 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.') + + # Minor optimization to avoid making a copy if the user passes + # in a oslogin.DeletePosixAccountRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + 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), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def delete_ssh_public_key(self, + request: oslogin.DeleteSshPublicKeyRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> None: + r"""Deletes an SSH public key. + + Args: + request (google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest): + 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. + # Sanity 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.') + + # Minor optimization to avoid making a copy if the user passes + # in a oslogin.DeleteSshPublicKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + 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), + )), + ) + + # Send the request. + rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + def get_login_profile(self, + request: oslogin.GetLoginProfileRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> oslogin.LoginProfile: + r"""Retrieves the profile information used for logging in + to a virtual machine on Google Compute Engine. + + Args: + request (google.cloud.oslogin_v1.types.GetLoginProfileRequest): + 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. + # Sanity 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.') + + # Minor optimization to avoid making a copy if the user passes + # in a oslogin.GetLoginProfileRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + 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), + )), + ) + + # 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: oslogin.GetSshPublicKeyRequest = None, + *, + name: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> common.SshPublicKey: + r"""Retrieves an SSH public key. + + Args: + request (google.cloud.oslogin_v1.types.GetSshPublicKeyRequest): + 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.common_pb2.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + # Create or coerce a protobuf request object. + # Sanity 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.') + + # Minor optimization to avoid making a copy if the user passes + # in a oslogin.GetSshPublicKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + 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), + )), + ) + + # 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: oslogin.ImportSshPublicKeyRequest = None, + *, + parent: str = None, + ssh_public_key: common.SshPublicKey = None, + project_id: str = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + 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. + + Args: + request (google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest): + 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.common_pb2.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. + # Sanity 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.') + + # Minor optimization to avoid making a copy if the user passes + # in a oslogin.ImportSshPublicKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + 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), + )), + ) + + # 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: oslogin.UpdateSshPublicKeyRequest = None, + *, + name: str = None, + ssh_public_key: common.SshPublicKey = None, + update_mask: field_mask.FieldMask = None, + retry: retries.Retry = gapic_v1.method.DEFAULT, + timeout: float = None, + metadata: Sequence[Tuple[str, str]] = (), + ) -> common.SshPublicKey: + r"""Updates an SSH public key and returns the profile + information. This method supports patch semantics. + + Args: + request (google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest): + 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.common_pb2.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.common_pb2.SshPublicKey: + The SSH public key information + associated with a Google account. + + """ + # Create or coerce a protobuf request object. + # Sanity 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.') + + # Minor optimization to avoid making a copy if the user passes + # in a oslogin.UpdateSshPublicKeyRequest. + # There's no risk of modifying the input as we've already verified + # there are no flattened fields. + 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), + )), + ) + + # Send the request. + response = rpc( + request, + retry=retry, + timeout=timeout, + metadata=metadata, + ) + + # Done; return the response. + return response + + + + + + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-oslogin', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + + +__all__ = ( + 'OsLoginServiceClient', +) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py new file mode 100644 index 0000000..fd03221 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py @@ -0,0 +1,35 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from collections import OrderedDict +from typing import Dict, Type + +from .base import OsLoginServiceTransport +from .grpc import OsLoginServiceGrpcTransport +from .grpc_asyncio import OsLoginServiceGrpcAsyncIOTransport + + +# Compile a registry of transports. +_transport_registry = OrderedDict() # type: Dict[str, Type[OsLoginServiceTransport]] +_transport_registry['grpc'] = OsLoginServiceGrpcTransport +_transport_registry['grpc_asyncio'] = OsLoginServiceGrpcAsyncIOTransport + +__all__ = ( + 'OsLoginServiceTransport', + 'OsLoginServiceGrpcTransport', + 'OsLoginServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py new file mode 100644 index 0000000..965e754 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py @@ -0,0 +1,260 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import abc +import typing +import pkg_resources + +from google import auth # type: ignore +from google.api_core import exceptions # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google.api_core import retry as retries # type: ignore +from google.auth import credentials # type: ignore + +from google.cloud.oslogin.common import common_pb2 as common # type: ignore +from google.cloud.oslogin_v1.types import oslogin +from google.protobuf import empty_pb2 as empty # type: ignore + + +try: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( + gapic_version=pkg_resources.get_distribution( + 'google-cloud-oslogin', + ).version, + ) +except pkg_resources.DistributionNotFound: + DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() + +class OsLoginServiceTransport(abc.ABC): + """Abstract transport class for OsLoginService.""" + + AUTH_SCOPES = ( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/compute', + ) + + def __init__( + self, *, + host: str = 'oslogin.googleapis.com', + credentials: credentials.Credentials = None, + credentials_file: typing.Optional[str] = None, + scopes: typing.Optional[typing.Sequence[str]] = AUTH_SCOPES, + quota_project_id: typing.Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + **kwargs, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scope (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. + """ + # Save the hostname. Default to port 443 (HTTPS) if none is specified. + if ':' not in host: + host += ':443' + self._host = host + + # Save the scopes. + self._scopes = scopes or self.AUTH_SCOPES + + # If no credentials are provided, then determine the appropriate + # defaults. + if credentials and credentials_file: + raise exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") + + if credentials_file is not None: + credentials, _ = auth.load_credentials_from_file( + credentials_file, + scopes=self._scopes, + quota_project_id=quota_project_id + ) + + elif credentials is None: + credentials, _ = auth.default(scopes=self._scopes, quota_project_id=quota_project_id) + + # Save the credentials. + self._credentials = credentials + + def _prep_wrapped_messages(self, client_info): + # Precompute the wrapped methods. + self._wrapped_methods = { + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + 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( + exceptions.DeadlineExceeded, + exceptions.ServiceUnavailable, + ), + deadline=10.0, + ), + default_timeout=10.0, + client_info=client_info, + ), + + } + + @property + def delete_posix_account(self) -> typing.Callable[ + [oslogin.DeletePosixAccountRequest], + typing.Union[ + empty.Empty, + typing.Awaitable[empty.Empty] + ]]: + raise NotImplementedError() + + @property + def delete_ssh_public_key(self) -> typing.Callable[ + [oslogin.DeleteSshPublicKeyRequest], + typing.Union[ + empty.Empty, + typing.Awaitable[empty.Empty] + ]]: + raise NotImplementedError() + + @property + def get_login_profile(self) -> typing.Callable[ + [oslogin.GetLoginProfileRequest], + typing.Union[ + oslogin.LoginProfile, + typing.Awaitable[oslogin.LoginProfile] + ]]: + raise NotImplementedError() + + @property + def get_ssh_public_key(self) -> typing.Callable[ + [oslogin.GetSshPublicKeyRequest], + typing.Union[ + common.SshPublicKey, + typing.Awaitable[common.SshPublicKey] + ]]: + raise NotImplementedError() + + @property + def import_ssh_public_key(self) -> typing.Callable[ + [oslogin.ImportSshPublicKeyRequest], + typing.Union[ + oslogin.ImportSshPublicKeyResponse, + typing.Awaitable[oslogin.ImportSshPublicKeyResponse] + ]]: + raise NotImplementedError() + + @property + def update_ssh_public_key(self) -> typing.Callable[ + [oslogin.UpdateSshPublicKeyRequest], + typing.Union[ + common.SshPublicKey, + typing.Awaitable[common.SshPublicKey] + ]]: + raise NotImplementedError() + + +__all__ = ( + 'OsLoginServiceTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py new file mode 100644 index 0000000..a44a4cd --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py @@ -0,0 +1,388 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import warnings +from typing import Callable, Dict, Optional, Sequence, Tuple + +from google.api_core import grpc_helpers # type: ignore +from google.api_core import gapic_v1 # type: ignore +from google import auth # type: ignore +from google.auth import credentials # type: ignore +from google.auth.transport.grpc import SslCredentials # type: ignore + +import grpc # type: ignore + +from google.cloud.oslogin.common import common_pb2 as common # type: ignore +from google.cloud.oslogin_v1.types import oslogin +from google.protobuf import empty_pb2 as empty # 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: credentials.Credentials = None, + credentials_file: str = None, + scopes: Sequence[str] = None, + channel: grpc.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id: Optional[str] = None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional(Sequence[str])): A list of scopes. This argument is + ignored if ``channel`` is provided. + channel (Optional[grpc.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin 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 grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + 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: credentials.Credentials = None, + credentials_file: str = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> grpc.Channel: + """Create and return a gRPC channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is mutually exclusive with credentials. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + grpc.Channel: A gRPC channel object. + + Raises: + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + scopes = scopes or cls.AUTH_SCOPES + return grpc_helpers.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + **kwargs + ) + + @property + def grpc_channel(self) -> grpc.Channel: + """Return the channel designed to connect to this service. + """ + return self._grpc_channel + + @property + def delete_posix_account(self) -> Callable[ + [oslogin.DeletePosixAccountRequest], + empty.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.Empty.FromString, + ) + return self._stubs['delete_posix_account'] + + @property + def delete_ssh_public_key(self) -> Callable[ + [oslogin.DeleteSshPublicKeyRequest], + empty.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.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.FromString, + ) + 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.FromString, + ) + return self._stubs['update_ssh_public_key'] + + +__all__ = ( + 'OsLoginServiceGrpcTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py new file mode 100644 index 0000000..c24c8c5 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py @@ -0,0 +1,393 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import warnings +from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple + +from google.api_core import gapic_v1 # type: ignore +from google.api_core import grpc_helpers_async # type: ignore +from google import auth # type: ignore +from google.auth import 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 import common_pb2 as common # type: ignore +from google.cloud.oslogin_v1.types import oslogin +from google.protobuf import empty_pb2 as empty # 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: credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + quota_project_id: Optional[str] = None, + **kwargs) -> aio.Channel: + """Create and return a gRPC AsyncIO channel object. + Args: + host (Optional[str]): The host for the channel to use. + credentials (Optional[~.Credentials]): The + authorization credentials to attach to requests. These + credentials identify this application to the service. If + none are specified, the client will attempt to ascertain + the credentials from the environment. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + kwargs (Optional[dict]): Keyword arguments, which are passed to the + channel creation. + Returns: + aio.Channel: A gRPC AsyncIO channel object. + """ + scopes = scopes or cls.AUTH_SCOPES + return grpc_helpers_async.create_channel( + host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + **kwargs + ) + + def __init__(self, *, + host: str = 'oslogin.googleapis.com', + credentials: credentials.Credentials = None, + credentials_file: Optional[str] = None, + scopes: Optional[Sequence[str]] = None, + channel: aio.Channel = None, + api_mtls_endpoint: str = None, + client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, + ssl_channel_credentials: grpc.ChannelCredentials = None, + client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, + quota_project_id=None, + client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, + ) -> None: + """Instantiate the transport. + + Args: + host (Optional[str]): The hostname to connect to. + credentials (Optional[google.auth.credentials.Credentials]): The + authorization credentials to attach to requests. These + credentials identify the application to the service; if none + are specified, the client will attempt to ascertain the + credentials from the environment. + This argument is ignored if ``channel`` is provided. + credentials_file (Optional[str]): A file with credentials that can + be loaded with :func:`google.auth.load_credentials_from_file`. + This argument is ignored if ``channel`` is provided. + scopes (Optional[Sequence[str]]): A optional list of scopes needed for this + service. These are only used when credentials are not specified and + are passed to :func:`google.auth.default`. + channel (Optional[aio.Channel]): A ``Channel`` instance through + which to make calls. + api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. + If provided, it overrides the ``host`` argument and tries to create + a mutual TLS channel with client SSL credentials from + ``client_cert_source`` or applicatin 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 grpc channel. It is ignored if ``channel`` is provided. + client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): + A callback to provide client certificate bytes and private key bytes, + both in PEM format. It is used to configure mutual TLS channel. It is + ignored if ``channel`` or ``ssl_channel_credentials`` is provided. + quota_project_id (Optional[str]): An optional project to use for billing + and quota. + client_info (google.api_core.gapic_v1.client_info.ClientInfo): + The client info used to send a user-agent string along with + API requests. If ``None``, then default info will be used. + Generally, you only need to set this if you're developing + your own client library. + + Raises: + google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport + creation failed for any reason. + google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` + and ``credentials_file`` are passed. + """ + self._grpc_channel = None + self._ssl_channel_credentials = ssl_channel_credentials + self._stubs: Dict[str, Callable] = {} + + if api_mtls_endpoint: + warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) + if client_cert_source: + warnings.warn("client_cert_source is deprecated", DeprecationWarning) + + if channel: + # Ignore credentials if a channel was passed. + credentials = False + # If a channel was explicitly provided, set it. + self._grpc_channel = channel + self._ssl_channel_credentials = None + + else: + if api_mtls_endpoint: + host = api_mtls_endpoint + + # Create SSL credentials with client_cert_source or application + # default SSL credentials. + if client_cert_source: + cert, key = client_cert_source() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + else: + self._ssl_channel_credentials = SslCredentials().ssl_credentials + + else: + if client_cert_source_for_mtls and not ssl_channel_credentials: + cert, key = client_cert_source_for_mtls() + self._ssl_channel_credentials = grpc.ssl_channel_credentials( + certificate_chain=cert, private_key=key + ) + + # The base transport sets the host, credentials and scopes + super().__init__( + host=host, + credentials=credentials, + credentials_file=credentials_file, + scopes=scopes, + quota_project_id=quota_project_id, + client_info=client_info, + ) + + if not self._grpc_channel: + self._grpc_channel = type(self).create_channel( + self._host, + credentials=self._credentials, + credentials_file=credentials_file, + 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 delete_posix_account(self) -> Callable[ + [oslogin.DeletePosixAccountRequest], + Awaitable[empty.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.Empty.FromString, + ) + return self._stubs['delete_posix_account'] + + @property + def delete_ssh_public_key(self) -> Callable[ + [oslogin.DeleteSshPublicKeyRequest], + Awaitable[empty.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.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.FromString, + ) + 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.FromString, + ) + return self._stubs['update_ssh_public_key'] + + +__all__ = ( + 'OsLoginServiceGrpcAsyncIOTransport', +) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/types/__init__.py new file mode 100644 index 0000000..88e7d27 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin_v1/types/__init__.py @@ -0,0 +1,38 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +from .oslogin import ( + DeletePosixAccountRequest, + DeleteSshPublicKeyRequest, + GetLoginProfileRequest, + GetSshPublicKeyRequest, + ImportSshPublicKeyRequest, + ImportSshPublicKeyResponse, + LoginProfile, + UpdateSshPublicKeyRequest, +) + +__all__ = ( + 'DeletePosixAccountRequest', + 'DeleteSshPublicKeyRequest', + 'GetLoginProfileRequest', + 'GetSshPublicKeyRequest', + 'ImportSshPublicKeyRequest', + 'ImportSshPublicKeyResponse', + 'LoginProfile', + 'UpdateSshPublicKeyRequest', +) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/types/oslogin.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/types/oslogin.py new file mode 100644 index 0000000..08e6979 --- /dev/null +++ b/owl-bot-staging/v1/google/cloud/oslogin_v1/types/oslogin.py @@ -0,0 +1,196 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import proto # type: ignore + + +from google.cloud.oslogin.common import common_pb2 as common # type: ignore +from google.protobuf import field_mask_pb2 as field_mask # type: ignore + + +__protobuf__ = proto.module( + package='google.cloud.oslogin.v1', + manifest={ + 'LoginProfile', + '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 (Sequence[google.cloud.oslogin.common.common_pb2.PosixAccount]): + The list of POSIX accounts associated with + the user. + ssh_public_keys (Sequence[google.cloud.oslogin_v1.types.LoginProfile.SshPublicKeysEntry]): + A map from SSH public key fingerprint to the + associated key object. + """ + + name = proto.Field(proto.STRING, number=1) + + posix_accounts = proto.RepeatedField(proto.MESSAGE, number=2, + message=common.PosixAccount, + ) + + ssh_public_keys = proto.MapField(proto.STRING, proto.MESSAGE, number=3, + 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 = 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 = 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 = proto.Field(proto.STRING, number=1) + + project_id = proto.Field(proto.STRING, number=2) + + system_id = 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 = 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.common_pb2.SshPublicKey): + Optional. The SSH public key and expiration + time. + project_id (str): + The project ID of the Google Cloud Platform + project. + """ + + parent = proto.Field(proto.STRING, number=1) + + ssh_public_key = proto.Field(proto.MESSAGE, number=2, + message=common.SshPublicKey, + ) + + project_id = proto.Field(proto.STRING, number=3) + + +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. + """ + + login_profile = proto.Field(proto.MESSAGE, number=1, + message='LoginProfile', + ) + + +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.common_pb2.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 = proto.Field(proto.STRING, number=1) + + ssh_public_key = proto.Field(proto.MESSAGE, number=2, + message=common.SshPublicKey, + ) + + update_mask = proto.Field(proto.MESSAGE, number=3, + message=field_mask.FieldMask, + ) + + +__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini new file mode 100644 index 0000000..4505b48 --- /dev/null +++ b/owl-bot-staging/v1/mypy.ini @@ -0,0 +1,3 @@ +[mypy] +python_version = 3.6 +namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py new file mode 100644 index 0000000..c601378 --- /dev/null +++ b/owl-bot-staging/v1/noxfile.py @@ -0,0 +1,72 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import os +import shutil + +import nox # type: ignore + + +@nox.session(python=['3.6', '3.7', '3.8', '3.9']) +def unit(session): + """Run the unit test suite.""" + + session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') + session.install('-e', '.') + + session.run( + 'py.test', + '--quiet', + '--cov=google/cloud/oslogin/common/', + '--cov-config=.coveragerc', + '--cov-report=term', + '--cov-report=html', + os.path.join('tests', 'unit', ''.join(session.posargs)) + ) + + +@nox.session(python=['3.6', '3.7']) +def mypy(session): + """Run the type checker.""" + session.install('mypy') + session.install('.') + session.run( + 'mypy', + '--explicit-package-bases', + 'google', + ) + +@nox.session(python='3.6') +def docs(session): + """Build the docs for this library.""" + + session.install("-e", ".") + session.install("sphinx<3.0.0", "alabaster", "recommonmark") + + shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) + session.run( + "sphinx-build", + "-W", # warnings as errors + "-T", # show full traceback on exception + "-N", # no colors + "-b", + "html", + "-d", + os.path.join("docs", "_build", "doctrees", ""), + os.path.join("docs", ""), + os.path.join("docs", "_build", "html", ""), + ) diff --git a/owl-bot-staging/v1/scripts/fixup_common_keywords.py b/owl-bot-staging/v1/scripts/fixup_common_keywords.py new file mode 100644 index 0000000..d457969 --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_common_keywords.py @@ -0,0 +1,178 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class commonCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + + } + + 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: not a.keyword.value 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=commonCallTransformer(), +): + """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 common 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/v1/scripts/fixup_oslogin_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_oslogin_v1_keywords.py new file mode 100644 index 0000000..be08c0e --- /dev/null +++ b/owl-bot-staging/v1/scripts/fixup_oslogin_v1_keywords.py @@ -0,0 +1,184 @@ +#! /usr/bin/env python3 +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import argparse +import os +import libcst as cst +import pathlib +import sys +from typing import (Any, Callable, Dict, List, Sequence, Tuple) + + +def partition( + predicate: Callable[[Any], bool], + iterator: Sequence[Any] +) -> Tuple[List[Any], List[Any]]: + """A stable, out-of-place partition.""" + results = ([], []) + + for i in iterator: + results[int(predicate(i))].append(i) + + # Returns trueList, falseList + return results[1], results[0] + + +class osloginCallTransformer(cst.CSTTransformer): + CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') + METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { + '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', ), + '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: not a.keyword.value 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/v1/setup.py b/owl-bot-staging/v1/setup.py new file mode 100644 index 0000000..7a58330 --- /dev/null +++ b/owl-bot-staging/v1/setup.py @@ -0,0 +1,55 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import io +import os +import setuptools # type: ignore + +version = '0.1.0' + +package_root = os.path.abspath(os.path.dirname(__file__)) + +readme_filename = os.path.join(package_root, 'README.rst') +with io.open(readme_filename, encoding='utf-8') as readme_file: + readme = readme_file.read() + +setuptools.setup( + name='google-cloud-oslogin-common', + version=version, + long_description=readme, + packages=setuptools.PEP420PackageFinder.find(), + namespace_packages=('google', 'google.cloud', 'google.cloud.oslogin'), + platforms='Posix; MacOS X; Windows', + include_package_data=True, + install_requires=( + 'google-api-core[grpc] >= 1.22.2, < 2.0.0dev', + 'libcst >= 0.2.5', + 'proto-plus >= 1.15.0', + ), + python_requires='>=3.6', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Topic :: Internet', + 'Topic :: Software Development :: Libraries :: Python Modules', + ], + zip_safe=False, +) diff --git a/owl-bot-staging/v1/tests/unit/gapic/common/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/common/__init__.py new file mode 100644 index 0000000..6a73015 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/common/__init__.py @@ -0,0 +1,17 @@ + +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/__init__.py new file mode 100644 index 0000000..6a73015 --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/__init__.py @@ -0,0 +1,17 @@ + +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# diff --git a/owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py b/owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py new file mode 100644 index 0000000..4a69e0a --- /dev/null +++ b/owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py @@ -0,0 +1,2347 @@ +# -*- coding: utf-8 -*- + +# Copyright 2020 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +import os +import mock + +import grpc +from grpc.experimental import aio +import math +import pytest +from proto.marshal.rules.dates import DurationRule, TimestampRule + +from google import auth +from google.api_core import client_options +from google.api_core import 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.auth import credentials +from google.auth.exceptions import MutualTLSChannelError +from google.cloud.oslogin.common import common_pb2 as common # type: ignore +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 as field_mask # type: ignore + + +def client_cert_source_callback(): + return b"cert bytes", b"key bytes" + + +# If default endpoint is localhost, then default mtls endpoint will be the same. +# This method modifies the default endpoint so the client can produce a different +# mtls endpoint for endpoint testing purposes. +def modify_default_endpoint(client): + return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT + + +def test__get_default_mtls_endpoint(): + api_endpoint = "example.googleapis.com" + api_mtls_endpoint = "example.mtls.googleapis.com" + sandbox_endpoint = "example.sandbox.googleapis.com" + sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" + non_googleapi = "api.example.com" + + assert 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 + + +@pytest.mark.parametrize("client_class", [ + OsLoginServiceClient, + OsLoginServiceAsyncClient, +]) +def test_os_login_service_client_from_service_account_info(client_class): + creds = credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: + factory.return_value = creds + info = {"valid": True} + client = client_class.from_service_account_info(info) + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'oslogin.googleapis.com:443' + + +@pytest.mark.parametrize("client_class", [ + OsLoginServiceClient, + OsLoginServiceAsyncClient, +]) +def test_os_login_service_client_from_service_account_file(client_class): + creds = credentials.AnonymousCredentials() + with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: + factory.return_value = creds + client = client_class.from_service_account_file("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + client = client_class.from_service_account_json("dummy/file/path.json") + assert client.transport._credentials == creds + assert isinstance(client, client_class) + + assert client.transport._host == 'oslogin.googleapis.com:443' + + +def test_os_login_service_client_get_transport_class(): + transport = OsLoginServiceClient.get_transport_class() + available_transports = [ + transports.OsLoginServiceGrpcTransport, + ] + 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"), +]) +@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_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=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(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, + ) + + # 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() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # 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() + 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, + ) + + # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has + # unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): + with pytest.raises(MutualTLSChannelError): + client = client_class() + + # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): + with pytest.raises(ValueError): + client = client_class() + + # 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) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id="octopus", + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + +@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"), + +]) +@mock.patch.object(OsLoginServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OsLoginServiceClient)) +@mock.patch.object(OsLoginServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(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) + + if use_client_cert_env == "false": + expected_client_cert_source = None + expected_host = client.DEFAULT_ENDPOINT + else: + expected_client_cert_source = client_cert_source_callback + expected_host = client.DEFAULT_MTLS_ENDPOINT + + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=expected_host, + scopes=None, + client_cert_source_for_mtls=expected_client_cert_source, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + # Check the case ADC client cert is provided. Whether client cert is used depends on + # GOOGLE_API_USE_CLIENT_CERTIFICATE value. + with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): + with mock.patch.object(transport_class, '__init__') as patched: + with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): + with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): + if use_client_cert_env == "false": + expected_host = client.DEFAULT_ENDPOINT + expected_client_cert_source = None + else: + expected_host = client.DEFAULT_MTLS_ENDPOINT + expected_client_cert_source = client_cert_source_callback + + patched.return_value = None + client = client_class() + 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, + ) + + # 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() + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc"), + (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +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) + patched.assert_called_once_with( + credentials=None, + credentials_file=None, + host=client.DEFAULT_ENDPOINT, + scopes=["1", "2"], + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + +@pytest.mark.parametrize("client_class,transport_class,transport_name", [ + (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc"), + (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio"), +]) +def test_os_login_service_client_client_options_credentials_file(client_class, transport_class, transport_name): + # 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) + patched.assert_called_once_with( + credentials=None, + credentials_file="credentials.json", + host=client.DEFAULT_ENDPOINT, + scopes=None, + client_cert_source_for_mtls=None, + quota_project_id=None, + client_info=transports.base.DEFAULT_CLIENT_INFO, + ) + + +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, + ) + + +def test_delete_posix_account(transport: str = 'grpc', request_type=oslogin.DeletePosixAccountRequest): + client = OsLoginServiceClient( + credentials=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] + + assert args[0] == oslogin.DeletePosixAccountRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_posix_account_from_dict(): + test_delete_posix_account(request_type=dict) + + +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=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: + 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(transport: str = 'grpc_asyncio', request_type=oslogin.DeletePosixAccountRequest): + client = OsLoginServiceAsyncClient( + credentials=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] + + assert args[0] == oslogin.DeletePosixAccountRequest() + + # 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=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=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=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] + + assert args[0].name == 'name_value' + + +def test_delete_posix_account_flattened_error(): + client = OsLoginServiceClient( + credentials=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=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] + + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_delete_posix_account_flattened_error_async(): + client = OsLoginServiceAsyncClient( + credentials=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', + ) + + +def test_delete_ssh_public_key(transport: str = 'grpc', request_type=oslogin.DeleteSshPublicKeyRequest): + client = OsLoginServiceClient( + credentials=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] + + assert args[0] == oslogin.DeleteSshPublicKeyRequest() + + # Establish that the response is the type that we expect. + assert response is None + + +def test_delete_ssh_public_key_from_dict(): + test_delete_ssh_public_key(request_type=dict) + + +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=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: + 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(transport: str = 'grpc_asyncio', request_type=oslogin.DeleteSshPublicKeyRequest): + client = OsLoginServiceAsyncClient( + credentials=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] + + assert args[0] == oslogin.DeleteSshPublicKeyRequest() + + # 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=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=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=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] + + assert args[0].name == 'name_value' + + +def test_delete_ssh_public_key_flattened_error(): + client = OsLoginServiceClient( + credentials=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=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] + + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_delete_ssh_public_key_flattened_error_async(): + client = OsLoginServiceAsyncClient( + credentials=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', + ) + + +def test_get_login_profile(transport: str = 'grpc', request_type=oslogin.GetLoginProfileRequest): + client = OsLoginServiceClient( + credentials=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] + + assert args[0] == oslogin.GetLoginProfileRequest() + + # 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_from_dict(): + test_get_login_profile(request_type=dict) + + +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=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: + 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(transport: str = 'grpc_asyncio', request_type=oslogin.GetLoginProfileRequest): + client = OsLoginServiceAsyncClient( + credentials=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] + + assert args[0] == oslogin.GetLoginProfileRequest() + + # 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=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=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=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] + + assert args[0].name == 'name_value' + + +def test_get_login_profile_flattened_error(): + client = OsLoginServiceClient( + credentials=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=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] + + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_login_profile_flattened_error_async(): + client = OsLoginServiceAsyncClient( + credentials=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', + ) + + +def test_get_ssh_public_key(transport: str = 'grpc', request_type=oslogin.GetSshPublicKeyRequest): + client = OsLoginServiceClient( + credentials=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] + + assert args[0] == oslogin.GetSshPublicKeyRequest() + + # 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_from_dict(): + test_get_ssh_public_key(request_type=dict) + + +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=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: + 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(transport: str = 'grpc_asyncio', request_type=oslogin.GetSshPublicKeyRequest): + client = OsLoginServiceAsyncClient( + credentials=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] + + assert args[0] == oslogin.GetSshPublicKeyRequest() + + # 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=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=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=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] + + assert args[0].name == 'name_value' + + +def test_get_ssh_public_key_flattened_error(): + client = OsLoginServiceClient( + credentials=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=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] + + assert args[0].name == 'name_value' + + +@pytest.mark.asyncio +async def test_get_ssh_public_key_flattened_error_async(): + client = OsLoginServiceAsyncClient( + credentials=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', + ) + + +def test_import_ssh_public_key(transport: str = 'grpc', request_type=oslogin.ImportSshPublicKeyRequest): + client = OsLoginServiceClient( + credentials=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( + ) + + 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] + + assert args[0] == oslogin.ImportSshPublicKeyRequest() + + # Establish that the response is the type that we expect. + + assert isinstance(response, oslogin.ImportSshPublicKeyResponse) + + +def test_import_ssh_public_key_from_dict(): + test_import_ssh_public_key(request_type=dict) + + +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=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: + 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(transport: str = 'grpc_asyncio', request_type=oslogin.ImportSshPublicKeyRequest): + client = OsLoginServiceAsyncClient( + credentials=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( + )) + + 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] + + assert args[0] == oslogin.ImportSshPublicKeyRequest() + + # Establish that the response is the type that we expect. + assert isinstance(response, oslogin.ImportSshPublicKeyResponse) + + +@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=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=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=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] + + assert args[0].parent == 'parent_value' + + assert args[0].ssh_public_key == common.SshPublicKey(key='key_value') + + assert args[0].project_id == 'project_id_value' + + +def test_import_ssh_public_key_flattened_error(): + client = OsLoginServiceClient( + credentials=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=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] + + assert args[0].parent == 'parent_value' + + assert args[0].ssh_public_key == common.SshPublicKey(key='key_value') + + assert args[0].project_id == 'project_id_value' + + +@pytest.mark.asyncio +async def test_import_ssh_public_key_flattened_error_async(): + client = OsLoginServiceAsyncClient( + credentials=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', + ) + + +def test_update_ssh_public_key(transport: str = 'grpc', request_type=oslogin.UpdateSshPublicKeyRequest): + client = OsLoginServiceClient( + credentials=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] + + assert args[0] == oslogin.UpdateSshPublicKeyRequest() + + # 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_from_dict(): + test_update_ssh_public_key(request_type=dict) + + +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=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: + 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(transport: str = 'grpc_asyncio', request_type=oslogin.UpdateSshPublicKeyRequest): + client = OsLoginServiceAsyncClient( + credentials=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] + + assert args[0] == oslogin.UpdateSshPublicKeyRequest() + + # 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=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=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=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.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] + + assert args[0].name == 'name_value' + + assert args[0].ssh_public_key == common.SshPublicKey(key='key_value') + + assert args[0].update_mask == field_mask.FieldMask(paths=['paths_value']) + + +def test_update_ssh_public_key_flattened_error(): + client = OsLoginServiceClient( + credentials=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.FieldMask(paths=['paths_value']), + ) + + +@pytest.mark.asyncio +async def test_update_ssh_public_key_flattened_async(): + client = OsLoginServiceAsyncClient( + credentials=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.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] + + assert args[0].name == 'name_value' + + assert args[0].ssh_public_key == common.SshPublicKey(key='key_value') + + assert args[0].update_mask == field_mask.FieldMask(paths=['paths_value']) + + +@pytest.mark.asyncio +async def test_update_ssh_public_key_flattened_error_async(): + client = OsLoginServiceAsyncClient( + credentials=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.FieldMask(paths=['paths_value']), + ) + + +def test_credentials_transport_error(): + # It is an error to provide credentials and a transport instance. + transport = transports.OsLoginServiceGrpcTransport( + credentials=credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OsLoginServiceClient( + credentials=credentials.AnonymousCredentials(), + transport=transport, + ) + + # It is an error to provide a credentials file and a transport instance. + transport = transports.OsLoginServiceGrpcTransport( + credentials=credentials.AnonymousCredentials(), + ) + with pytest.raises(ValueError): + client = OsLoginServiceClient( + client_options={"credentials_file": "credentials.json"}, + transport=transport, + ) + + # It is an error to provide scopes and a transport instance. + transport = transports.OsLoginServiceGrpcTransport( + credentials=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=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=credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + transport = transports.OsLoginServiceGrpcAsyncIOTransport( + credentials=credentials.AnonymousCredentials(), + ) + channel = transport.grpc_channel + assert channel + + +@pytest.mark.parametrize("transport_class", [ + transports.OsLoginServiceGrpcTransport, + transports.OsLoginServiceGrpcAsyncIOTransport, +]) +def test_transport_adc(transport_class): + # Test default credentials are used if not provided. + with mock.patch.object(auth, 'default') as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + transport_class() + adc.assert_called_once() + + +def test_transport_grpc_default(): + # A client should use the gRPC transport by default. + client = OsLoginServiceClient( + credentials=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(exceptions.DuplicateCredentialArgs): + transport = transports.OsLoginServiceTransport( + credentials=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=credentials.AnonymousCredentials(), + ) + + # Every method on the transport should just blindly + # raise NotImplementedError. + methods = ( + '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()) + + +def test_os_login_service_base_transport_with_credentials_file(): + # Instantiate the base transport with a credentials file + with mock.patch.object(auth, 'load_credentials_from_file') 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 = (credentials.AnonymousCredentials(), None) + transport = transports.OsLoginServiceTransport( + credentials_file="credentials.json", + quota_project_id="octopus", + ) + load_creds.assert_called_once_with("credentials.json", scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/compute', + ), + 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(auth, 'default') 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 = (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(auth, 'default') as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + OsLoginServiceClient() + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/compute',), + quota_project_id=None, + ) + + +def test_os_login_service_transport_auth_adc(): + # If credentials and host are not provided, the transport class should use + # ADC credentials. + with mock.patch.object(auth, 'default') as adc: + adc.return_value = (credentials.AnonymousCredentials(), None) + transports.OsLoginServiceGrpcTransport(host="squid.clam.whelk", quota_project_id="octopus") + adc.assert_called_once_with(scopes=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/compute',), + quota_project_id="octopus", + ) + + +@pytest.mark.parametrize("transport_class", [transports.OsLoginServiceGrpcTransport, transports.OsLoginServiceGrpcAsyncIOTransport]) +def test_os_login_service_grpc_transport_client_cert_source_for_mtls( + transport_class +): + cred = 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=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/compute', + ), + 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_host_no_port(): + client = OsLoginServiceClient( + credentials=credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='oslogin.googleapis.com'), + ) + assert client.transport._host == 'oslogin.googleapis.com:443' + + +def test_os_login_service_host_with_port(): + client = OsLoginServiceClient( + credentials=credentials.AnonymousCredentials(), + client_options=client_options.ClientOptions(api_endpoint='oslogin.googleapis.com:8000'), + ) + assert client.transport._host == 'oslogin.googleapis.com:8000' + + +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 = credentials.AnonymousCredentials() + with pytest.warns(DeprecationWarning): + with mock.patch.object(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=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/compute', + ), + 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=( + 'https://www.googleapis.com/auth/cloud-platform', + 'https://www.googleapis.com/auth/compute', + ), + 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_withDEFAULT_CLIENT_INFO(): + client_info = gapic_v1.client_info.ClientInfo() + + with mock.patch.object(transports.OsLoginServiceTransport, '_prep_wrapped_messages') as prep: + client = OsLoginServiceClient( + credentials=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=credentials.AnonymousCredentials(), + client_info=client_info, + ) + prep.assert_called_once_with(client_info) From d76d8971de092cb36dd795912b143c630c30e8da Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Tue, 11 May 2021 22:57:37 -0400 Subject: [PATCH 3/3] chore: run the post processor --- .pre-commit-config.yaml | 2 +- CONTRIBUTING.rst | 16 +- noxfile.py | 14 +- owl-bot-staging/v1/MANIFEST.in | 2 - owl-bot-staging/v1/README.rst | 49 - owl-bot-staging/v1/docs/common/services.rst | 4 - owl-bot-staging/v1/docs/common/types.rst | 7 - owl-bot-staging/v1/docs/conf.py | 378 --- owl-bot-staging/v1/docs/index.rst | 7 - .../v1/docs/oslogin_v1/os_login_service.rst | 6 - .../v1/docs/oslogin_v1/services.rst | 6 - owl-bot-staging/v1/docs/oslogin_v1/types.rst | 7 - .../v1/google/cloud/oslogin/__init__.py | 40 - .../google/cloud/oslogin/common/__init__.py | 27 - .../v1/google/cloud/oslogin/common/py.typed | 2 - .../cloud/oslogin/common/services/__init__.py | 16 - .../cloud/oslogin/common/types/__init__.py | 28 - .../cloud/oslogin/common/types/common.py | 125 - .../v1/google/cloud/oslogin/py.typed | 2 - .../v1/google/cloud/oslogin_v1/__init__.py | 39 - .../v1/google/cloud/oslogin_v1/py.typed | 2 - .../cloud/oslogin_v1/services/__init__.py | 16 - .../services/os_login_service/__init__.py | 24 - .../services/os_login_service/async_client.py | 738 ------ .../services/os_login_service/client.py | 865 ------ .../os_login_service/transports/__init__.py | 35 - .../os_login_service/transports/base.py | 260 -- .../os_login_service/transports/grpc.py | 388 --- .../transports/grpc_asyncio.py | 393 --- .../google/cloud/oslogin_v1/types/__init__.py | 38 - .../google/cloud/oslogin_v1/types/oslogin.py | 196 -- owl-bot-staging/v1/mypy.ini | 3 - owl-bot-staging/v1/noxfile.py | 72 - .../v1/scripts/fixup_common_keywords.py | 178 -- .../v1/scripts/fixup_oslogin_v1_keywords.py | 184 -- owl-bot-staging/v1/setup.py | 55 - .../v1/tests/unit/gapic/common/__init__.py | 17 - .../tests/unit/gapic/oslogin_v1/__init__.py | 17 - .../gapic/oslogin_v1/test_os_login_service.py | 2347 ----------------- 39 files changed, 4 insertions(+), 6601 deletions(-) delete mode 100644 owl-bot-staging/v1/MANIFEST.in delete mode 100644 owl-bot-staging/v1/README.rst delete mode 100644 owl-bot-staging/v1/docs/common/services.rst delete mode 100644 owl-bot-staging/v1/docs/common/types.rst delete mode 100644 owl-bot-staging/v1/docs/conf.py delete mode 100644 owl-bot-staging/v1/docs/index.rst delete mode 100644 owl-bot-staging/v1/docs/oslogin_v1/os_login_service.rst delete mode 100644 owl-bot-staging/v1/docs/oslogin_v1/services.rst delete mode 100644 owl-bot-staging/v1/docs/oslogin_v1/types.rst delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin/common/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin/common/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin/common/services/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin/common/types/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin/common/types/common.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/py.typed delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/client.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/types/__init__.py delete mode 100644 owl-bot-staging/v1/google/cloud/oslogin_v1/types/oslogin.py delete mode 100644 owl-bot-staging/v1/mypy.ini delete mode 100644 owl-bot-staging/v1/noxfile.py delete mode 100644 owl-bot-staging/v1/scripts/fixup_common_keywords.py delete mode 100644 owl-bot-staging/v1/scripts/fixup_oslogin_v1_keywords.py delete mode 100644 owl-bot-staging/v1/setup.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/common/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/__init__.py delete mode 100644 owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8912e9b..1bbd787 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -26,6 +26,6 @@ repos: hooks: - id: black - repo: https://gitlab.com/pycqa/flake8 - rev: 3.9.0 + rev: 3.9.1 hooks: - id: flake8 diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 199770f..62200e1 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -160,21 +160,7 @@ Running System Tests auth settings and change some configuration in your project to run all the tests. -- System tests will be run against an actual project and - so you'll need to provide some environment variables to facilitate - authentication to your project: - - - ``GOOGLE_APPLICATION_CREDENTIALS``: The path to a JSON key file; - Such a file can be downloaded directly from the developer's console by clicking - "Generate new JSON key". See private key - `docs `__ - for more details. - -- Once you have downloaded your json keys, set the environment variable - ``GOOGLE_APPLICATION_CREDENTIALS`` to the absolute path of the json file:: - - $ export GOOGLE_APPLICATION_CREDENTIALS="/Users//path/to/app_credentials.json" - +- System tests will be run against an actual project. You should use local credentials from gcloud when possible. See `Best practices for application authentication `__. Some tests require a service account. For those tests see `Authenticating as a service account `__. ************* Test Coverage diff --git a/noxfile.py b/noxfile.py index 4d37cd3..70417e8 100644 --- a/noxfile.py +++ b/noxfile.py @@ -62,16 +62,9 @@ def lint(session): session.run("flake8", "google", "tests") -@nox.session(python="3.6") +@nox.session(python=DEFAULT_PYTHON_VERSION) def blacken(session): - """Run black. - - Format code to uniform standard. - - This currently uses Python 3.6 due to the automated Kokoro run of synthtool. - That run uses an image that doesn't have 3.6 installed. Before updating this - check the state of the `gcp_ubuntu_config` we use for that Kokoro run. - """ + """Run black. Format code to uniform standard.""" session.install(BLACK_VERSION) session.run( "black", *BLACK_PATHS, @@ -131,9 +124,6 @@ def system(session): # Check the value of `RUN_SYSTEM_TESTS` env var. It defaults to true. if os.environ.get("RUN_SYSTEM_TESTS", "true") == "false": session.skip("RUN_SYSTEM_TESTS is set to false, skipping") - # Sanity check: Only run tests if the environment variable is set. - if not os.environ.get("GOOGLE_APPLICATION_CREDENTIALS", ""): - session.skip("Credentials must be set via environment variable") # Install pyopenssl for mTLS testing. if os.environ.get("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false") == "true": session.install("pyopenssl") diff --git a/owl-bot-staging/v1/MANIFEST.in b/owl-bot-staging/v1/MANIFEST.in deleted file mode 100644 index 8fc658a..0000000 --- a/owl-bot-staging/v1/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include google/cloud/oslogin/common *.py -recursive-include google/cloud/oslogin/common *.py diff --git a/owl-bot-staging/v1/README.rst b/owl-bot-staging/v1/README.rst deleted file mode 100644 index 0ceb83d..0000000 --- a/owl-bot-staging/v1/README.rst +++ /dev/null @@ -1,49 +0,0 @@ -Python Client for Google Cloud Oslogin Common 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 Common 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/v1/docs/common/services.rst b/owl-bot-staging/v1/docs/common/services.rst deleted file mode 100644 index 50d1192..0000000 --- a/owl-bot-staging/v1/docs/common/services.rst +++ /dev/null @@ -1,4 +0,0 @@ -Services for Google Cloud Oslogin Common API -============================================= -.. toctree:: - :maxdepth: 2 diff --git a/owl-bot-staging/v1/docs/common/types.rst b/owl-bot-staging/v1/docs/common/types.rst deleted file mode 100644 index 9aa70cd..0000000 --- a/owl-bot-staging/v1/docs/common/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -Types for Google Cloud Oslogin Common API -========================================== - -.. automodule:: google.cloud.oslogin.common.types - :members: - :undoc-members: - :show-inheritance: diff --git a/owl-bot-staging/v1/docs/conf.py b/owl-bot-staging/v1/docs/conf.py deleted file mode 100644 index c8dad41..0000000 --- a/owl-bot-staging/v1/docs/conf.py +++ /dev/null @@ -1,378 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -# -# google-cloud-oslogin-common 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 = "1.6.3" - -# 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 master toctree document. -master_doc = "index" - -# General information about the project. -project = u"google-cloud-oslogin-common" -copyright = u"2020, Google, LLC" -author = u"Google APIs" # TODO: autogenerate this bit - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The full version, including alpha/beta/rc tags. -release = __version__ -# The short X.Y version. -version = ".".join(release.split(".")[0:2]) - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["_build"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = "sphinx" - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = "alabaster" - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -html_theme_options = { - "description": "Google Cloud Oslogin 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-oslogin-common-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 = [ - ( - master_doc, - "google-cloud-oslogin-common.tex", - u"google-cloud-oslogin-common 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 = [ - ( - master_doc, - "google-cloud-oslogin-common", - u"Google Cloud Oslogin Common 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 = [ - ( - master_doc, - "google-cloud-oslogin-common", - u"google-cloud-oslogin-common Documentation", - author, - "google-cloud-oslogin-common", - "GAPIC library for Google Cloud Oslogin Common 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/v1/docs/index.rst b/owl-bot-staging/v1/docs/index.rst deleted file mode 100644 index fbec834..0000000 --- a/owl-bot-staging/v1/docs/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -------------- -.. toctree:: - :maxdepth: 2 - - common/services - common/types diff --git a/owl-bot-staging/v1/docs/oslogin_v1/os_login_service.rst b/owl-bot-staging/v1/docs/oslogin_v1/os_login_service.rst deleted file mode 100644 index 588b1fb..0000000 --- a/owl-bot-staging/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/v1/docs/oslogin_v1/services.rst b/owl-bot-staging/v1/docs/oslogin_v1/services.rst deleted file mode 100644 index 10a7155..0000000 --- a/owl-bot-staging/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/v1/docs/oslogin_v1/types.rst b/owl-bot-staging/v1/docs/oslogin_v1/types.rst deleted file mode 100644 index 202b5bb..0000000 --- a/owl-bot-staging/v1/docs/oslogin_v1/types.rst +++ /dev/null @@ -1,7 +0,0 @@ -Types for Google Cloud Oslogin v1 API -===================================== - -.. automodule:: google.cloud.oslogin_v1.types - :members: - :undoc-members: - :show-inheritance: diff --git a/owl-bot-staging/v1/google/cloud/oslogin/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin/__init__.py deleted file mode 100644 index 6b30081..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin/__init__.py +++ /dev/null @@ -1,40 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from google.cloud.oslogin_v1.services.os_login_service.async_client import OsLoginServiceAsyncClient -from google.cloud.oslogin_v1.services.os_login_service.client import OsLoginServiceClient -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__ = ( - 'DeletePosixAccountRequest', - 'DeleteSshPublicKeyRequest', - 'GetLoginProfileRequest', - 'GetSshPublicKeyRequest', - 'ImportSshPublicKeyRequest', - 'ImportSshPublicKeyResponse', - 'LoginProfile', - 'OsLoginServiceAsyncClient', - 'OsLoginServiceClient', - 'UpdateSshPublicKeyRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/oslogin/common/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin/common/__init__.py deleted file mode 100644 index f50a487..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin/common/__init__.py +++ /dev/null @@ -1,27 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from .types.common import OperatingSystemType -from .types.common import PosixAccount -from .types.common import SshPublicKey - - -__all__ = ( - 'OperatingSystemType', - 'SshPublicKey', -'PosixAccount', -) diff --git a/owl-bot-staging/v1/google/cloud/oslogin/common/py.typed b/owl-bot-staging/v1/google/cloud/oslogin/common/py.typed deleted file mode 100644 index 5f0cbe7..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin/common/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-oslogin-common package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/oslogin/common/services/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin/common/services/__init__.py deleted file mode 100644 index 42ffdf2..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin/common/services/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/google/cloud/oslogin/common/types/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin/common/types/__init__.py deleted file mode 100644 index 8de3149..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin/common/types/__init__.py +++ /dev/null @@ -1,28 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from .common import ( - PosixAccount, - SshPublicKey, - OperatingSystemType, -) - -__all__ = ( - 'PosixAccount', - 'SshPublicKey', - 'OperatingSystemType', -) diff --git a/owl-bot-staging/v1/google/cloud/oslogin/common/types/common.py b/owl-bot-staging/v1/google/cloud/oslogin/common/types/common.py deleted file mode 100644 index b673601..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin/common/types/common.py +++ /dev/null @@ -1,125 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -import proto # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.oslogin.common', - manifest={ - 'OperatingSystemType', - 'PosixAccount', - 'SshPublicKey', - }, -) - - -class OperatingSystemType(proto.Enum): - r"""The operating system options for account entries.""" - OPERATING_SYSTEM_TYPE_UNSPECIFIED = 0 - LINUX = 1 - WINDOWS = 2 - - -class PosixAccount(proto.Message): - r"""The POSIX account information associated with a Google - account. - - Attributes: - primary (bool): - Only one POSIX account can be marked as - primary. - username (str): - The username of the POSIX account. - uid (int): - The user ID. - gid (int): - The default group ID. - home_directory (str): - The path to the home directory for this - account. - shell (str): - The path to the logic shell for this account. - gecos (str): - The GECOS (user information) entry for this - account. - system_id (str): - System identifier for which account the - username or uid applies to. By default, the - empty value is used. - account_id (str): - Output only. A POSIX account identifier. - operating_system_type (google.cloud.oslogin.common.types.OperatingSystemType): - The operating system type where this account - applies. - name (str): - Output only. The canonical resource name. - """ - - primary = proto.Field(proto.BOOL, number=1) - - username = proto.Field(proto.STRING, number=2) - - uid = proto.Field(proto.INT64, number=3) - - gid = proto.Field(proto.INT64, number=4) - - home_directory = proto.Field(proto.STRING, number=5) - - shell = proto.Field(proto.STRING, number=6) - - gecos = proto.Field(proto.STRING, number=7) - - system_id = proto.Field(proto.STRING, number=8) - - account_id = proto.Field(proto.STRING, number=9) - - operating_system_type = proto.Field(proto.ENUM, number=10, - enum='OperatingSystemType', - ) - - name = proto.Field(proto.STRING, number=11) - - -class SshPublicKey(proto.Message): - r"""The SSH public key information associated with a Google - account. - - Attributes: - key (str): - Public key text in SSH format, defined by RFC4253 section - 6.6. - expiration_time_usec (int): - An expiration time in microseconds since - epoch. - fingerprint (str): - Output only. The SHA-256 fingerprint of the - SSH public key. - name (str): - Output only. The canonical resource name. - """ - - key = proto.Field(proto.STRING, number=1) - - expiration_time_usec = proto.Field(proto.INT64, number=2) - - fingerprint = proto.Field(proto.STRING, number=3) - - name = proto.Field(proto.STRING, number=4) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/google/cloud/oslogin/py.typed b/owl-bot-staging/v1/google/cloud/oslogin/py.typed deleted file mode 100644 index 825d05f..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-oslogin package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/__init__.py deleted file mode 100644 index ce63332..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin_v1/__init__.py +++ /dev/null @@ -1,39 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from .services.os_login_service import OsLoginServiceClient -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__ = ( - 'DeletePosixAccountRequest', - 'DeleteSshPublicKeyRequest', - 'GetLoginProfileRequest', - 'GetSshPublicKeyRequest', - 'ImportSshPublicKeyRequest', - 'ImportSshPublicKeyResponse', - 'LoginProfile', - 'UpdateSshPublicKeyRequest', -'OsLoginServiceClient', -) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/py.typed b/owl-bot-staging/v1/google/cloud/oslogin_v1/py.typed deleted file mode 100644 index 825d05f..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin_v1/py.typed +++ /dev/null @@ -1,2 +0,0 @@ -# Marker file for PEP 561. -# The google-cloud-oslogin package uses inline types. diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/__init__.py deleted file mode 100644 index 42ffdf2..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/__init__.py +++ /dev/null @@ -1,16 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py deleted file mode 100644 index 71afda0..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/__init__.py +++ /dev/null @@ -1,24 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from .client import OsLoginServiceClient -from .async_client import OsLoginServiceAsyncClient - -__all__ = ( - 'OsLoginServiceClient', - 'OsLoginServiceAsyncClient', -) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py deleted file mode 100644 index 66d1c30..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/async_client.py +++ /dev/null @@ -1,738 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from collections import OrderedDict -import functools -import re -from typing import Dict, Sequence, Tuple, Type, Union -import pkg_resources - -import google.api_core.client_options as ClientOptions # type: ignore -from google.api_core import exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials # type: ignore -from google.oauth2 import service_account # type: ignore - -from google.cloud.oslogin.common import common_pb2 as common # type: ignore -from google.cloud.oslogin_v1.types import oslogin -from google.protobuf import field_mask_pb2 as field_mask # 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 - - DEFAULT_ENDPOINT = OsLoginServiceClient.DEFAULT_ENDPOINT - DEFAULT_MTLS_ENDPOINT = OsLoginServiceClient.DEFAULT_MTLS_ENDPOINT - - 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 - - @property - def transport(self) -> OsLoginServiceTransport: - """Return the transport used by the client instance. - - Returns: - OsLoginServiceTransport: The transport used by the client instance. - """ - return self._client.transport - - get_transport_class = functools.partial(type(OsLoginServiceClient).get_transport_class, type(OsLoginServiceClient)) - - def __init__(self, *, - credentials: credentials.Credentials = None, - transport: Union[str, OsLoginServiceTransport] = 'grpc_asyncio', - client_options: ClientOptions = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiate 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 (Union[str, ~.OsLoginServiceTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (ClientOptions): Custom options for the client. It - won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - """ - - self._client = OsLoginServiceClient( - credentials=credentials, - transport=transport, - client_options=client_options, - client_info=client_info, - - ) - - async def delete_posix_account(self, - request: oslogin.DeletePosixAccountRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes a POSIX account. - - Args: - request (:class:`google.cloud.oslogin_v1.types.DeletePosixAccountRequest`): - 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.Retry): Designation of what errors, if any, - should be 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. - # Sanity 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.') - - 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 = gapic_v1.method_async.wrap_method( - self._client._transport.delete_posix_account, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - exceptions.DeadlineExceeded, - exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('name', request.name), - )), - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def delete_ssh_public_key(self, - request: oslogin.DeleteSshPublicKeyRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes an SSH public key. - - Args: - request (:class:`google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest`): - 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.Retry): Designation of what errors, if any, - should be 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. - # Sanity 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.') - - 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 = gapic_v1.method_async.wrap_method( - self._client._transport.delete_ssh_public_key, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - exceptions.DeadlineExceeded, - exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('name', request.name), - )), - ) - - # Send the request. - await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - async def get_login_profile(self, - request: oslogin.GetLoginProfileRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> oslogin.LoginProfile: - r"""Retrieves the profile information used for logging in - to a virtual machine on Google Compute Engine. - - Args: - request (:class:`google.cloud.oslogin_v1.types.GetLoginProfileRequest`): - 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.Retry): Designation of what errors, if any, - should be retried. - 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. - # Sanity 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.') - - 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 = gapic_v1.method_async.wrap_method( - self._client._transport.get_login_profile, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - exceptions.DeadlineExceeded, - exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('name', request.name), - )), - ) - - # 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: oslogin.GetSshPublicKeyRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> common.SshPublicKey: - r"""Retrieves an SSH public key. - - Args: - request (:class:`google.cloud.oslogin_v1.types.GetSshPublicKeyRequest`): - 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.Retry): Designation of what errors, if any, - should be retried. - 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.common_pb2.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - # Create or coerce a protobuf request object. - # Sanity 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.') - - 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 = gapic_v1.method_async.wrap_method( - self._client._transport.get_ssh_public_key, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - exceptions.DeadlineExceeded, - exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('name', request.name), - )), - ) - - # 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: oslogin.ImportSshPublicKeyRequest = None, - *, - parent: str = None, - ssh_public_key: common.SshPublicKey = None, - project_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - 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. - - Args: - request (:class:`google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest`): - 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.common_pb2.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.Retry): Designation of what errors, if any, - should be retried. - 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. - # Sanity 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.') - - 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 = gapic_v1.method_async.wrap_method( - self._client._transport.import_ssh_public_key, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - exceptions.DeadlineExceeded, - exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('parent', request.parent), - )), - ) - - # 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: oslogin.UpdateSshPublicKeyRequest = None, - *, - name: str = None, - ssh_public_key: common.SshPublicKey = None, - update_mask: field_mask.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> common.SshPublicKey: - r"""Updates an SSH public key and returns the profile - information. This method supports patch semantics. - - Args: - request (:class:`google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest`): - 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.common_pb2.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.Retry): Designation of what errors, if any, - should be retried. - 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.common_pb2.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - # Create or coerce a protobuf request object. - # Sanity 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.') - - 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 = gapic_v1.method_async.wrap_method( - self._client._transport.update_ssh_public_key, - default_retry=retries.Retry( - initial=0.1, - maximum=60.0, - multiplier=1.3, - predicate=retries.if_exception_type( - exceptions.DeadlineExceeded, - exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=DEFAULT_CLIENT_INFO, - ) - - # Certain fields should be provided within the metadata header; - # add these here. - metadata = tuple(metadata) + ( - gapic_v1.routing_header.to_grpc_metadata(( - ('name', request.name), - )), - ) - - # Send the request. - response = await rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-oslogin', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - 'OsLoginServiceAsyncClient', -) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/client.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/client.py deleted file mode 100644 index 05c097a..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/client.py +++ /dev/null @@ -1,865 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from collections import OrderedDict -from distutils import util -import os -import re -from typing import Callable, Dict, Optional, Sequence, Tuple, Type, Union -import pkg_resources - -from google.api_core import client_options as client_options_lib # type: ignore -from google.api_core import exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import 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 - -from google.cloud.oslogin.common import common_pb2 as common # type: ignore -from google.cloud.oslogin_v1.types import oslogin -from google.protobuf import field_mask_pb2 as field_mask # type: ignore - -from .transports.base import OsLoginServiceTransport, DEFAULT_CLIENT_INFO -from .transports.grpc import OsLoginServiceGrpcTransport -from .transports.grpc_asyncio import OsLoginServiceGrpcAsyncIOTransport - - -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 - - def get_transport_class(cls, - label: str = None, - ) -> Type[OsLoginServiceTransport]: - """Return 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): - """Convert api endpoint to mTLS endpoint. - Convert "*.sandbox.googleapis.com" and "*.googleapis.com" to - "*.mtls.sandbox.googleapis.com" and "*.mtls.googleapis.com" respectively. - Args: - api_endpoint (Optional[str]): the api endpoint to convert. - Returns: - str: converted mTLS api endpoint. - """ - if not api_endpoint: - return api_endpoint - - mtls_endpoint_re = re.compile( - r"(?P[^.]+)(?P\.mtls)?(?P\.sandbox)?(?P\.googleapis\.com)?" - ) - - m = mtls_endpoint_re.match(api_endpoint) - name, mtls, sandbox, googledomain = m.groups() - if mtls or not googledomain: - return api_endpoint - - if sandbox: - return api_endpoint.replace( - "sandbox.googleapis.com", "mtls.sandbox.googleapis.com" - ) - - return api_endpoint.replace(".googleapis.com", ".mtls.googleapis.com") - - DEFAULT_ENDPOINT = 'oslogin.googleapis.com' - DEFAULT_MTLS_ENDPOINT = _get_default_mtls_endpoint.__func__( # type: ignore - DEFAULT_ENDPOINT - ) - - @classmethod - def from_service_account_info(cls, info: dict, *args, **kwargs): - """Creates an instance of this client using the provided credentials info. - - Args: - info (dict): The service account private key info. - args: Additional arguments to pass to the constructor. - kwargs: Additional arguments to pass to the constructor. - - Returns: - 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: - """Return 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: - """Return 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]: - """Parse 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: - """Return 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]: - """Parse 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: - """Return 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: - """Return 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: - """Return 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: - """Return 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: - """Return 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 {} - - def __init__(self, *, - credentials: Optional[credentials.Credentials] = None, - transport: Union[str, OsLoginServiceTransport, None] = None, - client_options: Optional[client_options_lib.ClientOptions] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiate 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 (Union[str, OsLoginServiceTransport]): The - transport to use. If set to None, a transport is chosen - automatically. - client_options (google.api_core.client_options.ClientOptions): Custom options for the - client. It won't take effect if a ``transport`` instance is provided. - (1) The ``api_endpoint`` property can be used to override the - default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT - environment variable can also be used to override the endpoint: - "always" (always use the default mTLS endpoint), "never" (always - use the default regular endpoint) and "auto" (auto switch to the - default mTLS endpoint if client certificate is present, this is - the default value). However, the ``api_endpoint`` property takes - precedence if provided. - (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable - is "true", then the ``client_cert_source`` property can be used - to provide client certificate for mutual TLS transport. If - not provided, the default SSL client certificate will be used if - present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not - set, no client certificate will be used. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - """ - if isinstance(client_options, dict): - client_options = client_options_lib.from_dict(client_options) - if client_options is None: - client_options = client_options_lib.ClientOptions() - - # Create SSL credentials for mutual TLS if needed. - use_client_cert = bool(util.strtobool(os.getenv("GOOGLE_API_USE_CLIENT_CERTIFICATE", "false"))) - - client_cert_source_func = None - is_mtls = False - if use_client_cert: - if client_options.client_cert_source: - is_mtls = True - client_cert_source_func = client_options.client_cert_source - else: - is_mtls = mtls.has_default_client_cert_source() - client_cert_source_func = mtls.default_client_cert_source() if is_mtls else None - - # Figure out which api endpoint to use. - if client_options.api_endpoint is not None: - api_endpoint = client_options.api_endpoint - else: - use_mtls_env = os.getenv("GOOGLE_API_USE_MTLS_ENDPOINT", "auto") - if use_mtls_env == "never": - api_endpoint = self.DEFAULT_ENDPOINT - elif use_mtls_env == "always": - api_endpoint = self.DEFAULT_MTLS_ENDPOINT - elif use_mtls_env == "auto": - api_endpoint = self.DEFAULT_MTLS_ENDPOINT if is_mtls else self.DEFAULT_ENDPOINT - else: - raise MutualTLSChannelError( - "Unsupported GOOGLE_API_USE_MTLS_ENDPOINT value. Accepted values: never, auto, always" - ) - - # Save or instantiate the transport. - # Ordinarily, we provide the transport, but allowing a custom transport - # instance provides an extensibility point for unusual situations. - if isinstance(transport, OsLoginServiceTransport): - # transport is a OsLoginServiceTransport instance. - if credentials or client_options.credentials_file: - raise ValueError('When providing a transport instance, ' - 'provide its credentials directly.') - if client_options.scopes: - raise ValueError( - "When providing a transport instance, " - "provide its scopes directly." - ) - self._transport = transport - else: - Transport = type(self).get_transport_class(transport) - self._transport = Transport( - credentials=credentials, - credentials_file=client_options.credentials_file, - host=api_endpoint, - scopes=client_options.scopes, - client_cert_source_for_mtls=client_cert_source_func, - quota_project_id=client_options.quota_project_id, - client_info=client_info, - ) - - def delete_posix_account(self, - request: oslogin.DeletePosixAccountRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes a POSIX account. - - Args: - request (google.cloud.oslogin_v1.types.DeletePosixAccountRequest): - 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. - # Sanity 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a oslogin.DeletePosixAccountRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - 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), - )), - ) - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def delete_ssh_public_key(self, - request: oslogin.DeleteSshPublicKeyRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> None: - r"""Deletes an SSH public key. - - Args: - request (google.cloud.oslogin_v1.types.DeleteSshPublicKeyRequest): - 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. - # Sanity 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a oslogin.DeleteSshPublicKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - 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), - )), - ) - - # Send the request. - rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - def get_login_profile(self, - request: oslogin.GetLoginProfileRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> oslogin.LoginProfile: - r"""Retrieves the profile information used for logging in - to a virtual machine on Google Compute Engine. - - Args: - request (google.cloud.oslogin_v1.types.GetLoginProfileRequest): - 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. - # Sanity 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a oslogin.GetLoginProfileRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - 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), - )), - ) - - # 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: oslogin.GetSshPublicKeyRequest = None, - *, - name: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> common.SshPublicKey: - r"""Retrieves an SSH public key. - - Args: - request (google.cloud.oslogin_v1.types.GetSshPublicKeyRequest): - 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.common_pb2.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - # Create or coerce a protobuf request object. - # Sanity 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a oslogin.GetSshPublicKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - 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), - )), - ) - - # 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: oslogin.ImportSshPublicKeyRequest = None, - *, - parent: str = None, - ssh_public_key: common.SshPublicKey = None, - project_id: str = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - 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. - - Args: - request (google.cloud.oslogin_v1.types.ImportSshPublicKeyRequest): - 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.common_pb2.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. - # Sanity 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a oslogin.ImportSshPublicKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - 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), - )), - ) - - # 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: oslogin.UpdateSshPublicKeyRequest = None, - *, - name: str = None, - ssh_public_key: common.SshPublicKey = None, - update_mask: field_mask.FieldMask = None, - retry: retries.Retry = gapic_v1.method.DEFAULT, - timeout: float = None, - metadata: Sequence[Tuple[str, str]] = (), - ) -> common.SshPublicKey: - r"""Updates an SSH public key and returns the profile - information. This method supports patch semantics. - - Args: - request (google.cloud.oslogin_v1.types.UpdateSshPublicKeyRequest): - 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.common_pb2.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.common_pb2.SshPublicKey: - The SSH public key information - associated with a Google account. - - """ - # Create or coerce a protobuf request object. - # Sanity 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.') - - # Minor optimization to avoid making a copy if the user passes - # in a oslogin.UpdateSshPublicKeyRequest. - # There's no risk of modifying the input as we've already verified - # there are no flattened fields. - 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), - )), - ) - - # Send the request. - response = rpc( - request, - retry=retry, - timeout=timeout, - metadata=metadata, - ) - - # Done; return the response. - return response - - - - - - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-oslogin', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - - -__all__ = ( - 'OsLoginServiceClient', -) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py deleted file mode 100644 index fd03221..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/__init__.py +++ /dev/null @@ -1,35 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from collections import OrderedDict -from typing import Dict, Type - -from .base import OsLoginServiceTransport -from .grpc import OsLoginServiceGrpcTransport -from .grpc_asyncio import OsLoginServiceGrpcAsyncIOTransport - - -# Compile a registry of transports. -_transport_registry = OrderedDict() # type: Dict[str, Type[OsLoginServiceTransport]] -_transport_registry['grpc'] = OsLoginServiceGrpcTransport -_transport_registry['grpc_asyncio'] = OsLoginServiceGrpcAsyncIOTransport - -__all__ = ( - 'OsLoginServiceTransport', - 'OsLoginServiceGrpcTransport', - 'OsLoginServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py deleted file mode 100644 index 965e754..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/base.py +++ /dev/null @@ -1,260 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -import abc -import typing -import pkg_resources - -from google import auth # type: ignore -from google.api_core import exceptions # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google.api_core import retry as retries # type: ignore -from google.auth import credentials # type: ignore - -from google.cloud.oslogin.common import common_pb2 as common # type: ignore -from google.cloud.oslogin_v1.types import oslogin -from google.protobuf import empty_pb2 as empty # type: ignore - - -try: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo( - gapic_version=pkg_resources.get_distribution( - 'google-cloud-oslogin', - ).version, - ) -except pkg_resources.DistributionNotFound: - DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo() - -class OsLoginServiceTransport(abc.ABC): - """Abstract transport class for OsLoginService.""" - - AUTH_SCOPES = ( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/compute', - ) - - def __init__( - self, *, - host: str = 'oslogin.googleapis.com', - credentials: credentials.Credentials = None, - credentials_file: typing.Optional[str] = None, - scopes: typing.Optional[typing.Sequence[str]] = AUTH_SCOPES, - quota_project_id: typing.Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - **kwargs, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scope (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. - """ - # Save the hostname. Default to port 443 (HTTPS) if none is specified. - if ':' not in host: - host += ':443' - self._host = host - - # Save the scopes. - self._scopes = scopes or self.AUTH_SCOPES - - # If no credentials are provided, then determine the appropriate - # defaults. - if credentials and credentials_file: - raise exceptions.DuplicateCredentialArgs("'credentials_file' and 'credentials' are mutually exclusive") - - if credentials_file is not None: - credentials, _ = auth.load_credentials_from_file( - credentials_file, - scopes=self._scopes, - quota_project_id=quota_project_id - ) - - elif credentials is None: - credentials, _ = auth.default(scopes=self._scopes, quota_project_id=quota_project_id) - - # Save the credentials. - self._credentials = credentials - - def _prep_wrapped_messages(self, client_info): - # Precompute the wrapped methods. - self._wrapped_methods = { - 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( - exceptions.DeadlineExceeded, - 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( - exceptions.DeadlineExceeded, - 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( - exceptions.DeadlineExceeded, - 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( - exceptions.DeadlineExceeded, - 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( - exceptions.DeadlineExceeded, - 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( - exceptions.DeadlineExceeded, - exceptions.ServiceUnavailable, - ), - deadline=10.0, - ), - default_timeout=10.0, - client_info=client_info, - ), - - } - - @property - def delete_posix_account(self) -> typing.Callable[ - [oslogin.DeletePosixAccountRequest], - typing.Union[ - empty.Empty, - typing.Awaitable[empty.Empty] - ]]: - raise NotImplementedError() - - @property - def delete_ssh_public_key(self) -> typing.Callable[ - [oslogin.DeleteSshPublicKeyRequest], - typing.Union[ - empty.Empty, - typing.Awaitable[empty.Empty] - ]]: - raise NotImplementedError() - - @property - def get_login_profile(self) -> typing.Callable[ - [oslogin.GetLoginProfileRequest], - typing.Union[ - oslogin.LoginProfile, - typing.Awaitable[oslogin.LoginProfile] - ]]: - raise NotImplementedError() - - @property - def get_ssh_public_key(self) -> typing.Callable[ - [oslogin.GetSshPublicKeyRequest], - typing.Union[ - common.SshPublicKey, - typing.Awaitable[common.SshPublicKey] - ]]: - raise NotImplementedError() - - @property - def import_ssh_public_key(self) -> typing.Callable[ - [oslogin.ImportSshPublicKeyRequest], - typing.Union[ - oslogin.ImportSshPublicKeyResponse, - typing.Awaitable[oslogin.ImportSshPublicKeyResponse] - ]]: - raise NotImplementedError() - - @property - def update_ssh_public_key(self) -> typing.Callable[ - [oslogin.UpdateSshPublicKeyRequest], - typing.Union[ - common.SshPublicKey, - typing.Awaitable[common.SshPublicKey] - ]]: - raise NotImplementedError() - - -__all__ = ( - 'OsLoginServiceTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py deleted file mode 100644 index a44a4cd..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc.py +++ /dev/null @@ -1,388 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -import warnings -from typing import Callable, Dict, Optional, Sequence, Tuple - -from google.api_core import grpc_helpers # type: ignore -from google.api_core import gapic_v1 # type: ignore -from google import auth # type: ignore -from google.auth import credentials # type: ignore -from google.auth.transport.grpc import SslCredentials # type: ignore - -import grpc # type: ignore - -from google.cloud.oslogin.common import common_pb2 as common # type: ignore -from google.cloud.oslogin_v1.types import oslogin -from google.protobuf import empty_pb2 as empty # 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: credentials.Credentials = None, - credentials_file: str = None, - scopes: Sequence[str] = None, - channel: grpc.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id: Optional[str] = None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional(Sequence[str])): A list of scopes. This argument is - ignored if ``channel`` is provided. - channel (Optional[grpc.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or applicatin 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 grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTLSChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - 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: credentials.Credentials = None, - credentials_file: str = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> grpc.Channel: - """Create and return a gRPC channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is mutually exclusive with credentials. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - grpc.Channel: A gRPC channel object. - - Raises: - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - scopes = scopes or cls.AUTH_SCOPES - return grpc_helpers.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - **kwargs - ) - - @property - def grpc_channel(self) -> grpc.Channel: - """Return the channel designed to connect to this service. - """ - return self._grpc_channel - - @property - def delete_posix_account(self) -> Callable[ - [oslogin.DeletePosixAccountRequest], - empty.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.Empty.FromString, - ) - return self._stubs['delete_posix_account'] - - @property - def delete_ssh_public_key(self) -> Callable[ - [oslogin.DeleteSshPublicKeyRequest], - empty.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.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.FromString, - ) - 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.FromString, - ) - return self._stubs['update_ssh_public_key'] - - -__all__ = ( - 'OsLoginServiceGrpcTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py deleted file mode 100644 index c24c8c5..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin_v1/services/os_login_service/transports/grpc_asyncio.py +++ /dev/null @@ -1,393 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -import warnings -from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple - -from google.api_core import gapic_v1 # type: ignore -from google.api_core import grpc_helpers_async # type: ignore -from google import auth # type: ignore -from google.auth import 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 import common_pb2 as common # type: ignore -from google.cloud.oslogin_v1.types import oslogin -from google.protobuf import empty_pb2 as empty # 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: credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - quota_project_id: Optional[str] = None, - **kwargs) -> aio.Channel: - """Create and return a gRPC AsyncIO channel object. - Args: - host (Optional[str]): The host for the channel to use. - credentials (Optional[~.Credentials]): The - authorization credentials to attach to requests. These - credentials identify this application to the service. If - none are specified, the client will attempt to ascertain - the credentials from the environment. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - kwargs (Optional[dict]): Keyword arguments, which are passed to the - channel creation. - Returns: - aio.Channel: A gRPC AsyncIO channel object. - """ - scopes = scopes or cls.AUTH_SCOPES - return grpc_helpers_async.create_channel( - host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - **kwargs - ) - - def __init__(self, *, - host: str = 'oslogin.googleapis.com', - credentials: credentials.Credentials = None, - credentials_file: Optional[str] = None, - scopes: Optional[Sequence[str]] = None, - channel: aio.Channel = None, - api_mtls_endpoint: str = None, - client_cert_source: Callable[[], Tuple[bytes, bytes]] = None, - ssl_channel_credentials: grpc.ChannelCredentials = None, - client_cert_source_for_mtls: Callable[[], Tuple[bytes, bytes]] = None, - quota_project_id=None, - client_info: gapic_v1.client_info.ClientInfo = DEFAULT_CLIENT_INFO, - ) -> None: - """Instantiate the transport. - - Args: - host (Optional[str]): The hostname to connect to. - credentials (Optional[google.auth.credentials.Credentials]): The - authorization credentials to attach to requests. These - credentials identify the application to the service; if none - are specified, the client will attempt to ascertain the - credentials from the environment. - This argument is ignored if ``channel`` is provided. - credentials_file (Optional[str]): A file with credentials that can - be loaded with :func:`google.auth.load_credentials_from_file`. - This argument is ignored if ``channel`` is provided. - scopes (Optional[Sequence[str]]): A optional list of scopes needed for this - service. These are only used when credentials are not specified and - are passed to :func:`google.auth.default`. - channel (Optional[aio.Channel]): A ``Channel`` instance through - which to make calls. - api_mtls_endpoint (Optional[str]): Deprecated. The mutual TLS endpoint. - If provided, it overrides the ``host`` argument and tries to create - a mutual TLS channel with client SSL credentials from - ``client_cert_source`` or applicatin 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 grpc channel. It is ignored if ``channel`` is provided. - client_cert_source_for_mtls (Optional[Callable[[], Tuple[bytes, bytes]]]): - A callback to provide client certificate bytes and private key bytes, - both in PEM format. It is used to configure mutual TLS channel. It is - ignored if ``channel`` or ``ssl_channel_credentials`` is provided. - quota_project_id (Optional[str]): An optional project to use for billing - and quota. - client_info (google.api_core.gapic_v1.client_info.ClientInfo): - The client info used to send a user-agent string along with - API requests. If ``None``, then default info will be used. - Generally, you only need to set this if you're developing - your own client library. - - Raises: - google.auth.exceptions.MutualTlsChannelError: If mutual TLS transport - creation failed for any reason. - google.api_core.exceptions.DuplicateCredentialArgs: If both ``credentials`` - and ``credentials_file`` are passed. - """ - self._grpc_channel = None - self._ssl_channel_credentials = ssl_channel_credentials - self._stubs: Dict[str, Callable] = {} - - if api_mtls_endpoint: - warnings.warn("api_mtls_endpoint is deprecated", DeprecationWarning) - if client_cert_source: - warnings.warn("client_cert_source is deprecated", DeprecationWarning) - - if channel: - # Ignore credentials if a channel was passed. - credentials = False - # If a channel was explicitly provided, set it. - self._grpc_channel = channel - self._ssl_channel_credentials = None - - else: - if api_mtls_endpoint: - host = api_mtls_endpoint - - # Create SSL credentials with client_cert_source or application - # default SSL credentials. - if client_cert_source: - cert, key = client_cert_source() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - else: - self._ssl_channel_credentials = SslCredentials().ssl_credentials - - else: - if client_cert_source_for_mtls and not ssl_channel_credentials: - cert, key = client_cert_source_for_mtls() - self._ssl_channel_credentials = grpc.ssl_channel_credentials( - certificate_chain=cert, private_key=key - ) - - # The base transport sets the host, credentials and scopes - super().__init__( - host=host, - credentials=credentials, - credentials_file=credentials_file, - scopes=scopes, - quota_project_id=quota_project_id, - client_info=client_info, - ) - - if not self._grpc_channel: - self._grpc_channel = type(self).create_channel( - self._host, - credentials=self._credentials, - credentials_file=credentials_file, - 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 delete_posix_account(self) -> Callable[ - [oslogin.DeletePosixAccountRequest], - Awaitable[empty.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.Empty.FromString, - ) - return self._stubs['delete_posix_account'] - - @property - def delete_ssh_public_key(self) -> Callable[ - [oslogin.DeleteSshPublicKeyRequest], - Awaitable[empty.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.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.FromString, - ) - 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.FromString, - ) - return self._stubs['update_ssh_public_key'] - - -__all__ = ( - 'OsLoginServiceGrpcAsyncIOTransport', -) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/types/__init__.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/types/__init__.py deleted file mode 100644 index 88e7d27..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin_v1/types/__init__.py +++ /dev/null @@ -1,38 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -from .oslogin import ( - DeletePosixAccountRequest, - DeleteSshPublicKeyRequest, - GetLoginProfileRequest, - GetSshPublicKeyRequest, - ImportSshPublicKeyRequest, - ImportSshPublicKeyResponse, - LoginProfile, - UpdateSshPublicKeyRequest, -) - -__all__ = ( - 'DeletePosixAccountRequest', - 'DeleteSshPublicKeyRequest', - 'GetLoginProfileRequest', - 'GetSshPublicKeyRequest', - 'ImportSshPublicKeyRequest', - 'ImportSshPublicKeyResponse', - 'LoginProfile', - 'UpdateSshPublicKeyRequest', -) diff --git a/owl-bot-staging/v1/google/cloud/oslogin_v1/types/oslogin.py b/owl-bot-staging/v1/google/cloud/oslogin_v1/types/oslogin.py deleted file mode 100644 index 08e6979..0000000 --- a/owl-bot-staging/v1/google/cloud/oslogin_v1/types/oslogin.py +++ /dev/null @@ -1,196 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -import proto # type: ignore - - -from google.cloud.oslogin.common import common_pb2 as common # type: ignore -from google.protobuf import field_mask_pb2 as field_mask # type: ignore - - -__protobuf__ = proto.module( - package='google.cloud.oslogin.v1', - manifest={ - 'LoginProfile', - '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 (Sequence[google.cloud.oslogin.common.common_pb2.PosixAccount]): - The list of POSIX accounts associated with - the user. - ssh_public_keys (Sequence[google.cloud.oslogin_v1.types.LoginProfile.SshPublicKeysEntry]): - A map from SSH public key fingerprint to the - associated key object. - """ - - name = proto.Field(proto.STRING, number=1) - - posix_accounts = proto.RepeatedField(proto.MESSAGE, number=2, - message=common.PosixAccount, - ) - - ssh_public_keys = proto.MapField(proto.STRING, proto.MESSAGE, number=3, - 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 = 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 = 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 = proto.Field(proto.STRING, number=1) - - project_id = proto.Field(proto.STRING, number=2) - - system_id = 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 = 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.common_pb2.SshPublicKey): - Optional. The SSH public key and expiration - time. - project_id (str): - The project ID of the Google Cloud Platform - project. - """ - - parent = proto.Field(proto.STRING, number=1) - - ssh_public_key = proto.Field(proto.MESSAGE, number=2, - message=common.SshPublicKey, - ) - - project_id = proto.Field(proto.STRING, number=3) - - -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. - """ - - login_profile = proto.Field(proto.MESSAGE, number=1, - message='LoginProfile', - ) - - -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.common_pb2.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 = proto.Field(proto.STRING, number=1) - - ssh_public_key = proto.Field(proto.MESSAGE, number=2, - message=common.SshPublicKey, - ) - - update_mask = proto.Field(proto.MESSAGE, number=3, - message=field_mask.FieldMask, - ) - - -__all__ = tuple(sorted(__protobuf__.manifest)) diff --git a/owl-bot-staging/v1/mypy.ini b/owl-bot-staging/v1/mypy.ini deleted file mode 100644 index 4505b48..0000000 --- a/owl-bot-staging/v1/mypy.ini +++ /dev/null @@ -1,3 +0,0 @@ -[mypy] -python_version = 3.6 -namespace_packages = True diff --git a/owl-bot-staging/v1/noxfile.py b/owl-bot-staging/v1/noxfile.py deleted file mode 100644 index c601378..0000000 --- a/owl-bot-staging/v1/noxfile.py +++ /dev/null @@ -1,72 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -import os -import shutil - -import nox # type: ignore - - -@nox.session(python=['3.6', '3.7', '3.8', '3.9']) -def unit(session): - """Run the unit test suite.""" - - session.install('coverage', 'pytest', 'pytest-cov', 'asyncmock', 'pytest-asyncio') - session.install('-e', '.') - - session.run( - 'py.test', - '--quiet', - '--cov=google/cloud/oslogin/common/', - '--cov-config=.coveragerc', - '--cov-report=term', - '--cov-report=html', - os.path.join('tests', 'unit', ''.join(session.posargs)) - ) - - -@nox.session(python=['3.6', '3.7']) -def mypy(session): - """Run the type checker.""" - session.install('mypy') - session.install('.') - session.run( - 'mypy', - '--explicit-package-bases', - 'google', - ) - -@nox.session(python='3.6') -def docs(session): - """Build the docs for this library.""" - - session.install("-e", ".") - session.install("sphinx<3.0.0", "alabaster", "recommonmark") - - shutil.rmtree(os.path.join("docs", "_build"), ignore_errors=True) - session.run( - "sphinx-build", - "-W", # warnings as errors - "-T", # show full traceback on exception - "-N", # no colors - "-b", - "html", - "-d", - os.path.join("docs", "_build", "doctrees", ""), - os.path.join("docs", ""), - os.path.join("docs", "_build", "html", ""), - ) diff --git a/owl-bot-staging/v1/scripts/fixup_common_keywords.py b/owl-bot-staging/v1/scripts/fixup_common_keywords.py deleted file mode 100644 index d457969..0000000 --- a/owl-bot-staging/v1/scripts/fixup_common_keywords.py +++ /dev/null @@ -1,178 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -import argparse -import os -import libcst as cst -import pathlib -import sys -from typing import (Any, Callable, Dict, List, Sequence, Tuple) - - -def partition( - predicate: Callable[[Any], bool], - iterator: Sequence[Any] -) -> Tuple[List[Any], List[Any]]: - """A stable, out-of-place partition.""" - results = ([], []) - - for i in iterator: - results[int(predicate(i))].append(i) - - # Returns trueList, falseList - return results[1], results[0] - - -class commonCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - - } - - 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: not a.keyword.value 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=commonCallTransformer(), -): - """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 common 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/v1/scripts/fixup_oslogin_v1_keywords.py b/owl-bot-staging/v1/scripts/fixup_oslogin_v1_keywords.py deleted file mode 100644 index be08c0e..0000000 --- a/owl-bot-staging/v1/scripts/fixup_oslogin_v1_keywords.py +++ /dev/null @@ -1,184 +0,0 @@ -#! /usr/bin/env python3 -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -import argparse -import os -import libcst as cst -import pathlib -import sys -from typing import (Any, Callable, Dict, List, Sequence, Tuple) - - -def partition( - predicate: Callable[[Any], bool], - iterator: Sequence[Any] -) -> Tuple[List[Any], List[Any]]: - """A stable, out-of-place partition.""" - results = ([], []) - - for i in iterator: - results[int(predicate(i))].append(i) - - # Returns trueList, falseList - return results[1], results[0] - - -class osloginCallTransformer(cst.CSTTransformer): - CTRL_PARAMS: Tuple[str] = ('retry', 'timeout', 'metadata') - METHOD_TO_PARAMS: Dict[str, Tuple[str]] = { - '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', ), - '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: not a.keyword.value 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/v1/setup.py b/owl-bot-staging/v1/setup.py deleted file mode 100644 index 7a58330..0000000 --- a/owl-bot-staging/v1/setup.py +++ /dev/null @@ -1,55 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -import io -import os -import setuptools # type: ignore - -version = '0.1.0' - -package_root = os.path.abspath(os.path.dirname(__file__)) - -readme_filename = os.path.join(package_root, 'README.rst') -with io.open(readme_filename, encoding='utf-8') as readme_file: - readme = readme_file.read() - -setuptools.setup( - name='google-cloud-oslogin-common', - version=version, - long_description=readme, - packages=setuptools.PEP420PackageFinder.find(), - namespace_packages=('google', 'google.cloud', 'google.cloud.oslogin'), - platforms='Posix; MacOS X; Windows', - include_package_data=True, - install_requires=( - 'google-api-core[grpc] >= 1.22.2, < 2.0.0dev', - 'libcst >= 0.2.5', - 'proto-plus >= 1.15.0', - ), - python_requires='>=3.6', - classifiers=[ - 'Development Status :: 3 - Alpha', - 'Intended Audience :: Developers', - 'Operating System :: OS Independent', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', - 'Topic :: Internet', - 'Topic :: Software Development :: Libraries :: Python Modules', - ], - zip_safe=False, -) diff --git a/owl-bot-staging/v1/tests/unit/gapic/common/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/common/__init__.py deleted file mode 100644 index 6a73015..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/common/__init__.py +++ /dev/null @@ -1,17 +0,0 @@ - -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/__init__.py b/owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/__init__.py deleted file mode 100644 index 6a73015..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/__init__.py +++ /dev/null @@ -1,17 +0,0 @@ - -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# diff --git a/owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py b/owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py deleted file mode 100644 index 4a69e0a..0000000 --- a/owl-bot-staging/v1/tests/unit/gapic/oslogin_v1/test_os_login_service.py +++ /dev/null @@ -1,2347 +0,0 @@ -# -*- coding: utf-8 -*- - -# Copyright 2020 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# - -import os -import mock - -import grpc -from grpc.experimental import aio -import math -import pytest -from proto.marshal.rules.dates import DurationRule, TimestampRule - -from google import auth -from google.api_core import client_options -from google.api_core import 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.auth import credentials -from google.auth.exceptions import MutualTLSChannelError -from google.cloud.oslogin.common import common_pb2 as common # type: ignore -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 as field_mask # type: ignore - - -def client_cert_source_callback(): - return b"cert bytes", b"key bytes" - - -# If default endpoint is localhost, then default mtls endpoint will be the same. -# This method modifies the default endpoint so the client can produce a different -# mtls endpoint for endpoint testing purposes. -def modify_default_endpoint(client): - return "foo.googleapis.com" if ("localhost" in client.DEFAULT_ENDPOINT) else client.DEFAULT_ENDPOINT - - -def test__get_default_mtls_endpoint(): - api_endpoint = "example.googleapis.com" - api_mtls_endpoint = "example.mtls.googleapis.com" - sandbox_endpoint = "example.sandbox.googleapis.com" - sandbox_mtls_endpoint = "example.mtls.sandbox.googleapis.com" - non_googleapi = "api.example.com" - - assert 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 - - -@pytest.mark.parametrize("client_class", [ - OsLoginServiceClient, - OsLoginServiceAsyncClient, -]) -def test_os_login_service_client_from_service_account_info(client_class): - creds = credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_info') as factory: - factory.return_value = creds - info = {"valid": True} - client = client_class.from_service_account_info(info) - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'oslogin.googleapis.com:443' - - -@pytest.mark.parametrize("client_class", [ - OsLoginServiceClient, - OsLoginServiceAsyncClient, -]) -def test_os_login_service_client_from_service_account_file(client_class): - creds = credentials.AnonymousCredentials() - with mock.patch.object(service_account.Credentials, 'from_service_account_file') as factory: - factory.return_value = creds - client = client_class.from_service_account_file("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - client = client_class.from_service_account_json("dummy/file/path.json") - assert client.transport._credentials == creds - assert isinstance(client, client_class) - - assert client.transport._host == 'oslogin.googleapis.com:443' - - -def test_os_login_service_client_get_transport_class(): - transport = OsLoginServiceClient.get_transport_class() - available_transports = [ - transports.OsLoginServiceGrpcTransport, - ] - 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"), -]) -@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_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=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(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, - ) - - # 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() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - # 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() - 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, - ) - - # Check the case api_endpoint is not provided and GOOGLE_API_USE_MTLS_ENDPOINT has - # unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_MTLS_ENDPOINT": "Unsupported"}): - with pytest.raises(MutualTLSChannelError): - client = client_class() - - # Check the case GOOGLE_API_USE_CLIENT_CERTIFICATE has unsupported value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": "Unsupported"}): - with pytest.raises(ValueError): - client = client_class() - - # 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) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id="octopus", - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - -@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"), - -]) -@mock.patch.object(OsLoginServiceClient, "DEFAULT_ENDPOINT", modify_default_endpoint(OsLoginServiceClient)) -@mock.patch.object(OsLoginServiceAsyncClient, "DEFAULT_ENDPOINT", modify_default_endpoint(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) - - if use_client_cert_env == "false": - expected_client_cert_source = None - expected_host = client.DEFAULT_ENDPOINT - else: - expected_client_cert_source = client_cert_source_callback - expected_host = client.DEFAULT_MTLS_ENDPOINT - - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=expected_host, - scopes=None, - client_cert_source_for_mtls=expected_client_cert_source, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - # Check the case ADC client cert is provided. Whether client cert is used depends on - # GOOGLE_API_USE_CLIENT_CERTIFICATE value. - with mock.patch.dict(os.environ, {"GOOGLE_API_USE_CLIENT_CERTIFICATE": use_client_cert_env}): - with mock.patch.object(transport_class, '__init__') as patched: - with mock.patch('google.auth.transport.mtls.has_default_client_cert_source', return_value=True): - with mock.patch('google.auth.transport.mtls.default_client_cert_source', return_value=client_cert_source_callback): - if use_client_cert_env == "false": - expected_host = client.DEFAULT_ENDPOINT - expected_client_cert_source = None - else: - expected_host = client.DEFAULT_MTLS_ENDPOINT - expected_client_cert_source = client_cert_source_callback - - patched.return_value = None - client = client_class() - 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, - ) - - # 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() - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc"), - (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -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) - patched.assert_called_once_with( - credentials=None, - credentials_file=None, - host=client.DEFAULT_ENDPOINT, - scopes=["1", "2"], - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - -@pytest.mark.parametrize("client_class,transport_class,transport_name", [ - (OsLoginServiceClient, transports.OsLoginServiceGrpcTransport, "grpc"), - (OsLoginServiceAsyncClient, transports.OsLoginServiceGrpcAsyncIOTransport, "grpc_asyncio"), -]) -def test_os_login_service_client_client_options_credentials_file(client_class, transport_class, transport_name): - # 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) - patched.assert_called_once_with( - credentials=None, - credentials_file="credentials.json", - host=client.DEFAULT_ENDPOINT, - scopes=None, - client_cert_source_for_mtls=None, - quota_project_id=None, - client_info=transports.base.DEFAULT_CLIENT_INFO, - ) - - -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, - ) - - -def test_delete_posix_account(transport: str = 'grpc', request_type=oslogin.DeletePosixAccountRequest): - client = OsLoginServiceClient( - credentials=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] - - assert args[0] == oslogin.DeletePosixAccountRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_posix_account_from_dict(): - test_delete_posix_account(request_type=dict) - - -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=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: - 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(transport: str = 'grpc_asyncio', request_type=oslogin.DeletePosixAccountRequest): - client = OsLoginServiceAsyncClient( - credentials=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] - - assert args[0] == oslogin.DeletePosixAccountRequest() - - # 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=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=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=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] - - assert args[0].name == 'name_value' - - -def test_delete_posix_account_flattened_error(): - client = OsLoginServiceClient( - credentials=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=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] - - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_delete_posix_account_flattened_error_async(): - client = OsLoginServiceAsyncClient( - credentials=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', - ) - - -def test_delete_ssh_public_key(transport: str = 'grpc', request_type=oslogin.DeleteSshPublicKeyRequest): - client = OsLoginServiceClient( - credentials=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] - - assert args[0] == oslogin.DeleteSshPublicKeyRequest() - - # Establish that the response is the type that we expect. - assert response is None - - -def test_delete_ssh_public_key_from_dict(): - test_delete_ssh_public_key(request_type=dict) - - -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=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: - 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(transport: str = 'grpc_asyncio', request_type=oslogin.DeleteSshPublicKeyRequest): - client = OsLoginServiceAsyncClient( - credentials=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] - - assert args[0] == oslogin.DeleteSshPublicKeyRequest() - - # 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=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=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=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] - - assert args[0].name == 'name_value' - - -def test_delete_ssh_public_key_flattened_error(): - client = OsLoginServiceClient( - credentials=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=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] - - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_delete_ssh_public_key_flattened_error_async(): - client = OsLoginServiceAsyncClient( - credentials=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', - ) - - -def test_get_login_profile(transport: str = 'grpc', request_type=oslogin.GetLoginProfileRequest): - client = OsLoginServiceClient( - credentials=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] - - assert args[0] == oslogin.GetLoginProfileRequest() - - # 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_from_dict(): - test_get_login_profile(request_type=dict) - - -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=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: - 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(transport: str = 'grpc_asyncio', request_type=oslogin.GetLoginProfileRequest): - client = OsLoginServiceAsyncClient( - credentials=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] - - assert args[0] == oslogin.GetLoginProfileRequest() - - # 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=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=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=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] - - assert args[0].name == 'name_value' - - -def test_get_login_profile_flattened_error(): - client = OsLoginServiceClient( - credentials=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=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] - - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_login_profile_flattened_error_async(): - client = OsLoginServiceAsyncClient( - credentials=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', - ) - - -def test_get_ssh_public_key(transport: str = 'grpc', request_type=oslogin.GetSshPublicKeyRequest): - client = OsLoginServiceClient( - credentials=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] - - assert args[0] == oslogin.GetSshPublicKeyRequest() - - # 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_from_dict(): - test_get_ssh_public_key(request_type=dict) - - -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=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: - 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(transport: str = 'grpc_asyncio', request_type=oslogin.GetSshPublicKeyRequest): - client = OsLoginServiceAsyncClient( - credentials=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] - - assert args[0] == oslogin.GetSshPublicKeyRequest() - - # 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=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=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=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] - - assert args[0].name == 'name_value' - - -def test_get_ssh_public_key_flattened_error(): - client = OsLoginServiceClient( - credentials=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=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] - - assert args[0].name == 'name_value' - - -@pytest.mark.asyncio -async def test_get_ssh_public_key_flattened_error_async(): - client = OsLoginServiceAsyncClient( - credentials=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', - ) - - -def test_import_ssh_public_key(transport: str = 'grpc', request_type=oslogin.ImportSshPublicKeyRequest): - client = OsLoginServiceClient( - credentials=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( - ) - - 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] - - assert args[0] == oslogin.ImportSshPublicKeyRequest() - - # Establish that the response is the type that we expect. - - assert isinstance(response, oslogin.ImportSshPublicKeyResponse) - - -def test_import_ssh_public_key_from_dict(): - test_import_ssh_public_key(request_type=dict) - - -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=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: - 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(transport: str = 'grpc_asyncio', request_type=oslogin.ImportSshPublicKeyRequest): - client = OsLoginServiceAsyncClient( - credentials=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( - )) - - 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] - - assert args[0] == oslogin.ImportSshPublicKeyRequest() - - # Establish that the response is the type that we expect. - assert isinstance(response, oslogin.ImportSshPublicKeyResponse) - - -@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=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=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=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] - - assert args[0].parent == 'parent_value' - - assert args[0].ssh_public_key == common.SshPublicKey(key='key_value') - - assert args[0].project_id == 'project_id_value' - - -def test_import_ssh_public_key_flattened_error(): - client = OsLoginServiceClient( - credentials=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=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] - - assert args[0].parent == 'parent_value' - - assert args[0].ssh_public_key == common.SshPublicKey(key='key_value') - - assert args[0].project_id == 'project_id_value' - - -@pytest.mark.asyncio -async def test_import_ssh_public_key_flattened_error_async(): - client = OsLoginServiceAsyncClient( - credentials=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', - ) - - -def test_update_ssh_public_key(transport: str = 'grpc', request_type=oslogin.UpdateSshPublicKeyRequest): - client = OsLoginServiceClient( - credentials=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] - - assert args[0] == oslogin.UpdateSshPublicKeyRequest() - - # 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_from_dict(): - test_update_ssh_public_key(request_type=dict) - - -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=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: - 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(transport: str = 'grpc_asyncio', request_type=oslogin.UpdateSshPublicKeyRequest): - client = OsLoginServiceAsyncClient( - credentials=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] - - assert args[0] == oslogin.UpdateSshPublicKeyRequest() - - # 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=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=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=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.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] - - assert args[0].name == 'name_value' - - assert args[0].ssh_public_key == common.SshPublicKey(key='key_value') - - assert args[0].update_mask == field_mask.FieldMask(paths=['paths_value']) - - -def test_update_ssh_public_key_flattened_error(): - client = OsLoginServiceClient( - credentials=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.FieldMask(paths=['paths_value']), - ) - - -@pytest.mark.asyncio -async def test_update_ssh_public_key_flattened_async(): - client = OsLoginServiceAsyncClient( - credentials=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.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] - - assert args[0].name == 'name_value' - - assert args[0].ssh_public_key == common.SshPublicKey(key='key_value') - - assert args[0].update_mask == field_mask.FieldMask(paths=['paths_value']) - - -@pytest.mark.asyncio -async def test_update_ssh_public_key_flattened_error_async(): - client = OsLoginServiceAsyncClient( - credentials=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.FieldMask(paths=['paths_value']), - ) - - -def test_credentials_transport_error(): - # It is an error to provide credentials and a transport instance. - transport = transports.OsLoginServiceGrpcTransport( - credentials=credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = OsLoginServiceClient( - credentials=credentials.AnonymousCredentials(), - transport=transport, - ) - - # It is an error to provide a credentials file and a transport instance. - transport = transports.OsLoginServiceGrpcTransport( - credentials=credentials.AnonymousCredentials(), - ) - with pytest.raises(ValueError): - client = OsLoginServiceClient( - client_options={"credentials_file": "credentials.json"}, - transport=transport, - ) - - # It is an error to provide scopes and a transport instance. - transport = transports.OsLoginServiceGrpcTransport( - credentials=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=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=credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - transport = transports.OsLoginServiceGrpcAsyncIOTransport( - credentials=credentials.AnonymousCredentials(), - ) - channel = transport.grpc_channel - assert channel - - -@pytest.mark.parametrize("transport_class", [ - transports.OsLoginServiceGrpcTransport, - transports.OsLoginServiceGrpcAsyncIOTransport, -]) -def test_transport_adc(transport_class): - # Test default credentials are used if not provided. - with mock.patch.object(auth, 'default') as adc: - adc.return_value = (credentials.AnonymousCredentials(), None) - transport_class() - adc.assert_called_once() - - -def test_transport_grpc_default(): - # A client should use the gRPC transport by default. - client = OsLoginServiceClient( - credentials=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(exceptions.DuplicateCredentialArgs): - transport = transports.OsLoginServiceTransport( - credentials=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=credentials.AnonymousCredentials(), - ) - - # Every method on the transport should just blindly - # raise NotImplementedError. - methods = ( - '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()) - - -def test_os_login_service_base_transport_with_credentials_file(): - # Instantiate the base transport with a credentials file - with mock.patch.object(auth, 'load_credentials_from_file') 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 = (credentials.AnonymousCredentials(), None) - transport = transports.OsLoginServiceTransport( - credentials_file="credentials.json", - quota_project_id="octopus", - ) - load_creds.assert_called_once_with("credentials.json", scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/compute', - ), - 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(auth, 'default') 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 = (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(auth, 'default') as adc: - adc.return_value = (credentials.AnonymousCredentials(), None) - OsLoginServiceClient() - adc.assert_called_once_with(scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/compute',), - quota_project_id=None, - ) - - -def test_os_login_service_transport_auth_adc(): - # If credentials and host are not provided, the transport class should use - # ADC credentials. - with mock.patch.object(auth, 'default') as adc: - adc.return_value = (credentials.AnonymousCredentials(), None) - transports.OsLoginServiceGrpcTransport(host="squid.clam.whelk", quota_project_id="octopus") - adc.assert_called_once_with(scopes=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/compute',), - quota_project_id="octopus", - ) - - -@pytest.mark.parametrize("transport_class", [transports.OsLoginServiceGrpcTransport, transports.OsLoginServiceGrpcAsyncIOTransport]) -def test_os_login_service_grpc_transport_client_cert_source_for_mtls( - transport_class -): - cred = 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=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/compute', - ), - 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_host_no_port(): - client = OsLoginServiceClient( - credentials=credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='oslogin.googleapis.com'), - ) - assert client.transport._host == 'oslogin.googleapis.com:443' - - -def test_os_login_service_host_with_port(): - client = OsLoginServiceClient( - credentials=credentials.AnonymousCredentials(), - client_options=client_options.ClientOptions(api_endpoint='oslogin.googleapis.com:8000'), - ) - assert client.transport._host == 'oslogin.googleapis.com:8000' - - -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 = credentials.AnonymousCredentials() - with pytest.warns(DeprecationWarning): - with mock.patch.object(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=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/compute', - ), - 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=( - 'https://www.googleapis.com/auth/cloud-platform', - 'https://www.googleapis.com/auth/compute', - ), - 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_withDEFAULT_CLIENT_INFO(): - client_info = gapic_v1.client_info.ClientInfo() - - with mock.patch.object(transports.OsLoginServiceTransport, '_prep_wrapped_messages') as prep: - client = OsLoginServiceClient( - credentials=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=credentials.AnonymousCredentials(), - client_info=client_info, - ) - prep.assert_called_once_with(client_info)