diff --git a/packages/google-cloud-monitoring-dashboards/.github/.OwlBot.lock.yaml b/packages/google-cloud-monitoring-dashboards/.github/.OwlBot.lock.yaml new file mode 100644 index 000000000000..d49860b32e70 --- /dev/null +++ b/packages/google-cloud-monitoring-dashboards/.github/.OwlBot.lock.yaml @@ -0,0 +1,4 @@ +docker: + digest: sha256:457583330eec64daa02aeb7a72a04d33e7be2428f646671ce4045dcbc0191b1e + image: gcr.io/repo-automation-bots/owlbot-python:latest + diff --git a/packages/google-cloud-monitoring-dashboards/.github/.OwlBot.yaml b/packages/google-cloud-monitoring-dashboards/.github/.OwlBot.yaml new file mode 100644 index 000000000000..f541974b34e1 --- /dev/null +++ b/packages/google-cloud-monitoring-dashboards/.github/.OwlBot.yaml @@ -0,0 +1,26 @@ +# Copyright 2021 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +docker: + image: gcr.io/repo-automation-bots/owlbot-python:latest + +deep-remove-regex: + - /owl-bot-staging + +deep-copy-regex: + - source: /google/monitoring/dashboard/(v.*)/.*-py/(.*) + dest: /owl-bot-staging/$1/$2 + +begin-after-commit-hash: b06c9034cfcbce180ba732d03be6526e5c8ea1bc + diff --git a/packages/google-cloud-monitoring-dashboards/.pre-commit-config.yaml b/packages/google-cloud-monitoring-dashboards/.pre-commit-config.yaml index 8912e9b5d7d7..1bbd787833ec 100644 --- a/packages/google-cloud-monitoring-dashboards/.pre-commit-config.yaml +++ b/packages/google-cloud-monitoring-dashboards/.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/packages/google-cloud-monitoring-dashboards/CONTRIBUTING.rst b/packages/google-cloud-monitoring-dashboards/CONTRIBUTING.rst index b9f26db30182..c3b239fe5ded 100644 --- a/packages/google-cloud-monitoring-dashboards/CONTRIBUTING.rst +++ b/packages/google-cloud-monitoring-dashboards/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/packages/google-cloud-monitoring-dashboards/noxfile.py b/packages/google-cloud-monitoring-dashboards/noxfile.py index b038287bd7d6..4ee0622a7e38 100644 --- a/packages/google-cloud-monitoring-dashboards/noxfile.py +++ b/packages/google-cloud-monitoring-dashboards/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/packages/google-cloud-monitoring-dashboards/owlbot.py b/packages/google-cloud-monitoring-dashboards/owlbot.py new file mode 100644 index 000000000000..5147c9ac5f7f --- /dev/null +++ b/packages/google-cloud-monitoring-dashboards/owlbot.py @@ -0,0 +1,64 @@ +# 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. + +"""This script is used to synthesize generated parts of this library.""" +import synthtool as s +import synthtool.gcp as gcp +from synthtool.languages import python + +common = gcp.CommonTemplates() + +default_version = "v1" + +for library in s.get_staging_dirs(default_version): + # Fix namespace + s.replace(library / "google/monitoring/**/*.py", + "google.monitoring.dashboard_{}".format(library.name), + "google.cloud.monitoring_dashboard_{}".format(library.name), + ) + + s.replace(library / "tests/unit/gapic/**/*.py", + "google.monitoring.dashboard_{}".format(library.name), + "google.cloud.monitoring_dashboard_{}".format(library.name), + ) + s.replace(library / "docs/**/*.rst", + "google.monitoring.dashboard_{}".format(library.name), + "google.cloud.monitoring_dashboard_{}".format(library.name), + ) + + s.move(library / "google/cloud/monitoring_dashboard_v1/proto") + s.move(library / "google/monitoring/dashboard", "google/cloud/monitoring_dashboard") + s.move(library / "google/monitoring/dashboard_v1", "google/cloud/monitoring_dashboard_v1") + s.move(library / "tests") + s.move(library / "scripts") + s.move(library / "docs", excludes=["index.rst"]) + +s.remove_staging_dirs() + +# ---------------------------------------------------------------------------- +# Add templated files +# ---------------------------------------------------------------------------- +templated_files = common.py_library( + samples=False, # set to True only if there are samples + microgenerator=True, + cov_level=96 +) +s.move(templated_files, excludes=[".coveragerc"]) # microgenerator has a good .coveragerc file + + +# Temporarily disable warnings due to +# https://github.com/googleapis/gapic-generator-python/issues/525 +s.replace("noxfile.py", '[\"\']-W[\"\']', '# "-W"') + +s.shell.run(["nox", "-s", "blacken"], hide_output=False) \ No newline at end of file diff --git a/packages/google-cloud-monitoring-dashboards/synth.metadata b/packages/google-cloud-monitoring-dashboards/synth.metadata deleted file mode 100644 index d71e1aad199c..000000000000 --- a/packages/google-cloud-monitoring-dashboards/synth.metadata +++ /dev/null @@ -1,160 +0,0 @@ -{ - "sources": [ - { - "git": { - "name": ".", - "remote": "https://github.com/googleapis/python-monitoring-dashboards.git", - "sha": "28df537d621333a0bc8f83cbc4b1ebe274d520ba" - } - }, - { - "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" - } - }, - { - "git": { - "name": "synthtool", - "remote": "https://github.com/googleapis/synthtool.git", - "sha": "043cc620d6a6111816d9e09f2a97208565fde958" - } - } - ], - "destinations": [ - { - "client": { - "source": "googleapis", - "apiName": "monitoring_dashboard", - "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/dashboard_v1/dashboards_service.rst", - "docs/dashboard_v1/services.rst", - "docs/dashboard_v1/types.rst", - "docs/multiprocessing.rst", - "google/cloud/monitoring_dashboard/__init__.py", - "google/cloud/monitoring_dashboard/py.typed", - "google/cloud/monitoring_dashboard_v1/__init__.py", - "google/cloud/monitoring_dashboard_v1/proto/common.proto", - "google/cloud/monitoring_dashboard_v1/proto/dashboard.proto", - "google/cloud/monitoring_dashboard_v1/proto/dashboards_service.proto", - "google/cloud/monitoring_dashboard_v1/proto/drilldowns.proto", - "google/cloud/monitoring_dashboard_v1/proto/layouts.proto", - "google/cloud/monitoring_dashboard_v1/proto/metrics.proto", - "google/cloud/monitoring_dashboard_v1/proto/scorecard.proto", - "google/cloud/monitoring_dashboard_v1/proto/service.proto", - "google/cloud/monitoring_dashboard_v1/proto/text.proto", - "google/cloud/monitoring_dashboard_v1/proto/widget.proto", - "google/cloud/monitoring_dashboard_v1/proto/xychart.proto", - "google/cloud/monitoring_dashboard_v1/py.typed", - "google/cloud/monitoring_dashboard_v1/services/__init__.py", - "google/cloud/monitoring_dashboard_v1/services/dashboards_service/__init__.py", - "google/cloud/monitoring_dashboard_v1/services/dashboards_service/async_client.py", - "google/cloud/monitoring_dashboard_v1/services/dashboards_service/client.py", - "google/cloud/monitoring_dashboard_v1/services/dashboards_service/pagers.py", - "google/cloud/monitoring_dashboard_v1/services/dashboards_service/transports/__init__.py", - "google/cloud/monitoring_dashboard_v1/services/dashboards_service/transports/base.py", - "google/cloud/monitoring_dashboard_v1/services/dashboards_service/transports/grpc.py", - "google/cloud/monitoring_dashboard_v1/services/dashboards_service/transports/grpc_asyncio.py", - "google/cloud/monitoring_dashboard_v1/types/__init__.py", - "google/cloud/monitoring_dashboard_v1/types/common.py", - "google/cloud/monitoring_dashboard_v1/types/dashboard.py", - "google/cloud/monitoring_dashboard_v1/types/dashboards_service.py", - "google/cloud/monitoring_dashboard_v1/types/drilldowns.py", - "google/cloud/monitoring_dashboard_v1/types/layouts.py", - "google/cloud/monitoring_dashboard_v1/types/metrics.py", - "google/cloud/monitoring_dashboard_v1/types/scorecard.py", - "google/cloud/monitoring_dashboard_v1/types/service.py", - "google/cloud/monitoring_dashboard_v1/types/text.py", - "google/cloud/monitoring_dashboard_v1/types/widget.py", - "google/cloud/monitoring_dashboard_v1/types/xychart.py", - "noxfile.py", - "renovate.json", - "samples/AUTHORING_GUIDE.md", - "samples/CONTRIBUTING.md", - "scripts/decrypt-secrets.sh", - "scripts/fixup_dashboard_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/dashboard_v1/__init__.py", - "tests/unit/gapic/dashboard_v1/test_dashboards_service.py" - ] -} \ No newline at end of file diff --git a/packages/google-cloud-monitoring-dashboards/synth.py b/packages/google-cloud-monitoring-dashboards/synth.py deleted file mode 100644 index 414b6bc4afe0..000000000000 --- a/packages/google-cloud-monitoring-dashboards/synth.py +++ /dev/null @@ -1,80 +0,0 @@ -# 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. - -"""This script is used to synthesize generated parts of this library.""" -import synthtool as s -import synthtool.gcp as gcp -from synthtool.languages import python - -gapic = gcp.GAPICBazel() -common = gcp.CommonTemplates() - -# ---------------------------------------------------------------------------- -# Generate monitoring dashboards GAPIC layer -# ---------------------------------------------------------------------------- -library = gapic.py_library( - service="monitoring_dashboard", - version="v1", - bazel_target="//google/monitoring/dashboard/v1:monitoring-dashboard-v1-py", - include_protos=True, -) - -s.move(library / "google/cloud/monitoring_dashboard_v1/proto") -s.move(library / "google/monitoring/dashboard", "google/cloud/monitoring_dashboard") -s.move( - library / "google/monitoring/dashboard_v1", - "google/cloud/monitoring_dashboard_v1" -) -s.move(library / "tests") -s.move(library / "scripts") -s.move(library / "docs", excludes=[library / "docs/index.rst"]) - -# Fix namespace -s.replace( - "google/cloud/**/*.py", - "google.monitoring.dashboard_v1", - "google.cloud.monitoring_dashboard_v1", -) -s.replace( - "tests/unit/gapic/**/*.py", - "google.monitoring.dashboard_v1", - "google.cloud.monitoring_dashboard_v1", -) -s.replace( - "docs/**/*.rst", - "google.monitoring.dashboard_v1", - "google.cloud.monitoring_dashboard_v1", -) - -# Keep cloud in package names for consistency -s.replace( - "google/**/*.py", "google-cloud-monitoring-dashboard", "google-cloud-monitoring-dashboards" -) - -# ---------------------------------------------------------------------------- -# Add templated files -# ---------------------------------------------------------------------------- -templated_files = common.py_library( - samples=False, # set to True only if there are samples - microgenerator=True, - cov_level=96 -) -s.move(templated_files, excludes=[".coveragerc"]) # microgenerator has a good .coveragerc file - - -# Temporarily disable warnings due to -# https://github.com/googleapis/gapic-generator-python/issues/525 -s.replace("noxfile.py", '[\"\']-W[\"\']', '# "-W"') - -s.shell.run(["nox", "-s", "blacken"], hide_output=False)