diff --git a/packages/google-cloud-trace/samples/snippets/batch_write_spans.py b/packages/google-cloud-trace/samples/snippets/batch_write_spans.py deleted file mode 100644 index 9627c6a3850d..000000000000 --- a/packages/google-cloud-trace/samples/snippets/batch_write_spans.py +++ /dev/null @@ -1,44 +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 datetime -import uuid - -from google.cloud import trace_v2 - - -def batch_write_spans(project_id: str): - """Send new spans to new or existing traces.""" - - client = trace_v2.TraceServiceClient() - - display_name = trace_v2.TruncatableString(value="Test Span Display Name") - trace_id = str(uuid.uuid4()).replace("-", "") - span_id = str(uuid.uuid4()).replace("-", "")[:16] - - end_time = datetime.datetime.now(tz=datetime.timezone.utc) - start_time = end_time - datetime.timedelta(seconds=5) - - # Create a single span - span = trace_v2.Span( - name=client.span_path(project_id, trace_id, span_id), - span_id=span_id, - display_name=display_name, - start_time=start_time, - end_time=end_time, - ) - - client.batch_write_spans(name=f"projects/{project_id}", spans=[span]) diff --git a/packages/google-cloud-trace/samples/snippets/batch_write_spans_test.py b/packages/google-cloud-trace/samples/snippets/batch_write_spans_test.py deleted file mode 100644 index b414ca50df1a..000000000000 --- a/packages/google-cloud-trace/samples/snippets/batch_write_spans_test.py +++ /dev/null @@ -1,25 +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 batch_write_spans - -PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"] - - -def test_get_trace(): - batch_write_spans.batch_write_spans(project_id=PROJECT_ID) diff --git a/packages/google-cloud-trace/samples/snippets/create_span.py b/packages/google-cloud-trace/samples/snippets/create_span.py deleted file mode 100644 index 6e4d1cc6b28b..000000000000 --- a/packages/google-cloud-trace/samples/snippets/create_span.py +++ /dev/null @@ -1,61 +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 datetime - -from google.cloud import trace_v2 - - -def create_span( - project_id: str, - trace_id: str, - span_id: str, - display_name: str, - start_time: datetime.datetime, - end_time: datetime.datetime, -): - """Create a new span. - - Args: - project_id: The name of the project. - trace_id: A unique identifier for a trace within a - project; it is a 32-character hexadecimal encoding of a - 16-byte array. - span_id: A unique identifier for a span within a trace; - it is a 16-character hexadecimal encoding of an 8-byte - display_name: A description of the span's - operation (up to 128 bytes) - start_time: The start time of the span. - end_time: The end time of the span. - """ - - client = trace_v2.TraceServiceClient() - - name = client.span_path(project_id, trace_id, span_id) - display_name = trace_v2.TruncatableString(value=display_name) - - request = trace_v2.Span( - name=name, - span_id=span_id, - display_name=display_name, - start_time=start_time, - end_time=end_time, - ) - - span = client.create_span(request=request) - - print(span) - return span diff --git a/packages/google-cloud-trace/samples/snippets/create_span_test.py b/packages/google-cloud-trace/samples/snippets/create_span_test.py deleted file mode 100644 index 255bf35c07a4..000000000000 --- a/packages/google-cloud-trace/samples/snippets/create_span_test.py +++ /dev/null @@ -1,41 +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 datetime -import os -import uuid - -import create_span - -PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"] - - -def test_get_trace(): - trace_id = str(uuid.uuid4()).replace("-", "") - span_id = str(uuid.uuid4()).replace("-", "")[:16] - end_time = datetime.datetime.now(tz=datetime.timezone.utc) - start_time = end_time - datetime.timedelta(seconds=5) - - span = create_span.create_span( - project_id=PROJECT_ID, - trace_id=trace_id, - span_id=span_id, - display_name="test", - start_time=start_time, - end_time=end_time, - ) - - assert span.name == f"projects/{PROJECT_ID}/traces/{trace_id}/spans/{span_id}" diff --git a/packages/google-cloud-trace/samples/snippets/get_trace.py b/packages/google-cloud-trace/samples/snippets/get_trace.py deleted file mode 100644 index edfe01457365..000000000000 --- a/packages/google-cloud-trace/samples/snippets/get_trace.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 google.cloud import trace_v1 - - -def get_trace(project_id: str, trace_id: str): - """Get a trace by its ID.""" - - client = trace_v1.TraceServiceClient() - - trace = client.get_trace(project_id=project_id, trace_id=trace_id) - - print(trace) - return trace diff --git a/packages/google-cloud-trace/samples/snippets/get_trace_test.py b/packages/google-cloud-trace/samples/snippets/get_trace_test.py deleted file mode 100644 index 304c23b68213..000000000000 --- a/packages/google-cloud-trace/samples/snippets/get_trace_test.py +++ /dev/null @@ -1,37 +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 - -from google.cloud import trace_v1 -import pytest - -import get_trace - -PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"] - - -@pytest.fixture(scope="module") -def trace_id(): - # list all traces in the project and return the first - client = trace_v1.TraceServiceClient() - traces = client.list_traces(project_id=PROJECT_ID) - - return list(traces)[0].trace_id - - -def test_get_trace(trace_id): - get_trace.get_trace(project_id=PROJECT_ID, trace_id=trace_id) diff --git a/packages/google-cloud-trace/samples/snippets/list_traces.py b/packages/google-cloud-trace/samples/snippets/list_traces.py deleted file mode 100644 index 6e1701edf470..000000000000 --- a/packages/google-cloud-trace/samples/snippets/list_traces.py +++ /dev/null @@ -1,31 +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 import trace_v1 - - -def list_traces(project_id: str): - """List traces for a project.""" - - client = trace_v1.TraceServiceClient() - - request = trace_v1.ListTracesRequest(project_id=project_id) - traces = client.list_traces(request=request) - - for trace in traces: - print(trace) - - return traces diff --git a/packages/google-cloud-trace/samples/snippets/list_traces_test.py b/packages/google-cloud-trace/samples/snippets/list_traces_test.py deleted file mode 100644 index 380fe37a8291..000000000000 --- a/packages/google-cloud-trace/samples/snippets/list_traces_test.py +++ /dev/null @@ -1,26 +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 list_traces - -PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"] - - -def test_list_traces(): - traces = list_traces.list_traces(project_id=PROJECT_ID) - assert len(list(traces)) > 1 diff --git a/packages/google-cloud-trace/samples/snippets/noxfile.py b/packages/google-cloud-trace/samples/snippets/noxfile.py deleted file mode 100644 index de104dbc64d3..000000000000 --- a/packages/google-cloud-trace/samples/snippets/noxfile.py +++ /dev/null @@ -1,292 +0,0 @@ -# Copyright 2019 Google LLC -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -from __future__ import print_function - -import glob -import os -from pathlib import Path -import sys -from typing import Callable, Dict, Optional - -import nox - -# WARNING - WARNING - WARNING - WARNING - WARNING -# WARNING - WARNING - WARNING - WARNING - WARNING -# DO NOT EDIT THIS FILE EVER! -# WARNING - WARNING - WARNING - WARNING - WARNING -# WARNING - WARNING - WARNING - WARNING - WARNING - -BLACK_VERSION = "black==22.3.0" -ISORT_VERSION = "isort==5.10.1" - -# Copy `noxfile_config.py` to your directory and modify it instead. - -# `TEST_CONFIG` dict is a configuration hook that allows users to -# modify the test configurations. The values here should be in sync -# with `noxfile_config.py`. Users will copy `noxfile_config.py` into -# their directory and modify it. - -TEST_CONFIG = { - # You can opt out from the test for specific Python versions. - "ignored_versions": [], - # Old samples are opted out of enforcing Python type hints - # All new samples should feature them - "enforce_type_hints": False, - # An envvar key for determining the project id to use. Change it - # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a - # build specific Cloud project. You can also use your own string - # to use your own Cloud project. - "gcloud_project_env": "GOOGLE_CLOUD_PROJECT", - # 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT', - # If you need to use a specific version of pip, - # change pip_version_override to the string representation - # of the version number, for example, "20.2.4" - "pip_version_override": None, - # A dictionary you want to inject into your test. Don't put any - # secrets here. These values will override predefined values. - "envs": {}, -} - - -try: - # Ensure we can import noxfile_config in the project's directory. - sys.path.append(".") - from noxfile_config import TEST_CONFIG_OVERRIDE -except ImportError as e: - print("No user noxfile_config found: detail: {}".format(e)) - TEST_CONFIG_OVERRIDE = {} - -# Update the TEST_CONFIG with the user supplied values. -TEST_CONFIG.update(TEST_CONFIG_OVERRIDE) - - -def get_pytest_env_vars() -> Dict[str, str]: - """Returns a dict for pytest invocation.""" - ret = {} - - # Override the GCLOUD_PROJECT and the alias. - env_key = TEST_CONFIG["gcloud_project_env"] - # This should error out if not set. - ret["GOOGLE_CLOUD_PROJECT"] = os.environ[env_key] - - # Apply user supplied envs. - ret.update(TEST_CONFIG["envs"]) - return ret - - -# DO NOT EDIT - automatically generated. -# All versions used to test samples. -ALL_VERSIONS = ["3.7", "3.8", "3.9", "3.10", "3.11"] - -# Any default versions that should be ignored. -IGNORED_VERSIONS = TEST_CONFIG["ignored_versions"] - -TESTED_VERSIONS = sorted([v for v in ALL_VERSIONS if v not in IGNORED_VERSIONS]) - -INSTALL_LIBRARY_FROM_SOURCE = os.environ.get("INSTALL_LIBRARY_FROM_SOURCE", False) in ( - "True", - "true", -) - -# Error if a python version is missing -nox.options.error_on_missing_interpreters = True - -# -# Style Checks -# - - -# Linting with flake8. -# -# We ignore the following rules: -# E203: whitespace before ‘:’ -# E266: too many leading ‘#’ for block comment -# E501: line too long -# I202: Additional newline in a section of imports -# -# We also need to specify the rules which are ignored by default: -# ['E226', 'W504', 'E126', 'E123', 'W503', 'E24', 'E704', 'E121'] -FLAKE8_COMMON_ARGS = [ - "--show-source", - "--builtin=gettext", - "--max-complexity=20", - "--exclude=.nox,.cache,env,lib,generated_pb2,*_pb2.py,*_pb2_grpc.py", - "--ignore=E121,E123,E126,E203,E226,E24,E266,E501,E704,W503,W504,I202", - "--max-line-length=88", -] - - -@nox.session -def lint(session: nox.sessions.Session) -> None: - if not TEST_CONFIG["enforce_type_hints"]: - session.install("flake8") - else: - session.install("flake8", "flake8-annotations") - - args = FLAKE8_COMMON_ARGS + [ - ".", - ] - session.run("flake8", *args) - - -# -# Black -# - - -@nox.session -def blacken(session: nox.sessions.Session) -> None: - """Run black. Format code to uniform standard.""" - session.install(BLACK_VERSION) - python_files = [path for path in os.listdir(".") if path.endswith(".py")] - - session.run("black", *python_files) - - -# -# format = isort + black -# - - -@nox.session -def format(session: nox.sessions.Session) -> None: - """ - Run isort to sort imports. Then run black - to format code to uniform standard. - """ - session.install(BLACK_VERSION, ISORT_VERSION) - python_files = [path for path in os.listdir(".") if path.endswith(".py")] - - # Use the --fss option to sort imports using strict alphabetical order. - # See https://pycqa.github.io/isort/docs/configuration/options.html#force-sort-within-sections - session.run("isort", "--fss", *python_files) - session.run("black", *python_files) - - -# -# Sample Tests -# - - -PYTEST_COMMON_ARGS = ["--junitxml=sponge_log.xml"] - - -def _session_tests( - session: nox.sessions.Session, post_install: Callable = None -) -> None: - # check for presence of tests - test_list = glob.glob("**/*_test.py", recursive=True) + glob.glob( - "**/test_*.py", recursive=True - ) - test_list.extend(glob.glob("**/tests", recursive=True)) - - if len(test_list) == 0: - print("No tests found, skipping directory.") - return - - if TEST_CONFIG["pip_version_override"]: - pip_version = TEST_CONFIG["pip_version_override"] - session.install(f"pip=={pip_version}") - """Runs py.test for a particular project.""" - concurrent_args = [] - if os.path.exists("requirements.txt"): - if os.path.exists("constraints.txt"): - session.install("-r", "requirements.txt", "-c", "constraints.txt") - else: - session.install("-r", "requirements.txt") - with open("requirements.txt") as rfile: - packages = rfile.read() - - if os.path.exists("requirements-test.txt"): - if os.path.exists("constraints-test.txt"): - session.install("-r", "requirements-test.txt", "-c", "constraints-test.txt") - else: - session.install("-r", "requirements-test.txt") - with open("requirements-test.txt") as rtfile: - packages += rtfile.read() - - if INSTALL_LIBRARY_FROM_SOURCE: - session.install("-e", _get_repo_root()) - - if post_install: - post_install(session) - - if "pytest-parallel" in packages: - concurrent_args.extend(["--workers", "auto", "--tests-per-worker", "auto"]) - elif "pytest-xdist" in packages: - concurrent_args.extend(["-n", "auto"]) - - session.run( - "pytest", - *(PYTEST_COMMON_ARGS + session.posargs + concurrent_args), - # Pytest will return 5 when no tests are collected. This can happen - # on travis where slow and flaky tests are excluded. - # See http://doc.pytest.org/en/latest/_modules/_pytest/main.html - success_codes=[0, 5], - env=get_pytest_env_vars(), - ) - - -@nox.session(python=ALL_VERSIONS) -def py(session: nox.sessions.Session) -> None: - """Runs py.test for a sample using the specified version of Python.""" - if session.python in TESTED_VERSIONS: - _session_tests(session) - else: - session.skip( - "SKIPPED: {} tests are disabled for this sample.".format(session.python) - ) - - -# -# Readmegen -# - - -def _get_repo_root() -> Optional[str]: - """Returns the root folder of the project.""" - # Get root of this repository. Assume we don't have directories nested deeper than 10 items. - p = Path(os.getcwd()) - for i in range(10): - if p is None: - break - if Path(p / ".git").exists(): - return str(p) - # .git is not available in repos cloned via Cloud Build - # setup.py is always in the library's root, so use that instead - # https://github.com/googleapis/synthtool/issues/792 - if Path(p / "setup.py").exists(): - return str(p) - p = p.parent - raise Exception("Unable to detect repository root.") - - -GENERATED_READMES = sorted([x for x in Path(".").rglob("*.rst.in")]) - - -@nox.session -@nox.parametrize("path", GENERATED_READMES) -def readmegen(session: nox.sessions.Session, path: str) -> None: - """(Re-)generates the readme for a sample.""" - session.install("jinja2", "pyyaml") - dir_ = os.path.dirname(path) - - if os.path.exists(os.path.join(dir_, "requirements.txt")): - session.install("-r", os.path.join(dir_, "requirements.txt")) - - in_file = os.path.join(dir_, "README.rst.in") - session.run( - "python", _get_repo_root() + "/scripts/readme-gen/readme_gen.py", in_file - ) diff --git a/packages/google-cloud-trace/samples/snippets/patch_traces.py b/packages/google-cloud-trace/samples/snippets/patch_traces.py deleted file mode 100644 index 6a379e7d3d45..000000000000 --- a/packages/google-cloud-trace/samples/snippets/patch_traces.py +++ /dev/null @@ -1,37 +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 uuid - -from google.cloud import trace_v1 - - -def patch_traces(project_id: str): - """Send new traces or update existing traces.""" - - client = trace_v1.TraceServiceClient() - - trace = trace_v1.Trace( - project_id=project_id, - trace_id=str(uuid.uuid4()).replace("-", ""), - spans=[trace_v1.TraceSpan(span_id=1, name="test-span")], - ) - - request = trace_v1.PatchTracesRequest( - project_id=project_id, traces=trace_v1.Traces(traces=[trace]) - ) - - client.patch_traces(request=request) diff --git a/packages/google-cloud-trace/samples/snippets/patch_traces_test.py b/packages/google-cloud-trace/samples/snippets/patch_traces_test.py deleted file mode 100644 index b031ae7e3f70..000000000000 --- a/packages/google-cloud-trace/samples/snippets/patch_traces_test.py +++ /dev/null @@ -1,37 +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 - -from google.cloud import trace_v1 -import pytest - -import patch_traces - -PROJECT_ID = os.environ["GOOGLE_CLOUD_PROJECT"] - - -@pytest.fixture(scope="module") -def trace_id(): - # list all traces in the project and return the first - client = trace_v1.TraceServiceClient() - traces = client.list_traces(project_id=PROJECT_ID) - - return list(traces)[0].trace_id - - -def test_patch_traces(): - patch_traces.patch_traces(project_id=PROJECT_ID) diff --git a/packages/google-cloud-trace/samples/snippets/requirements-test.txt b/packages/google-cloud-trace/samples/snippets/requirements-test.txt deleted file mode 100644 index b705adb655e6..000000000000 --- a/packages/google-cloud-trace/samples/snippets/requirements-test.txt +++ /dev/null @@ -1 +0,0 @@ -pytest==7.2.2 \ No newline at end of file diff --git a/packages/google-cloud-trace/samples/snippets/requirements.txt b/packages/google-cloud-trace/samples/snippets/requirements.txt deleted file mode 100644 index bc263e4527de..000000000000 --- a/packages/google-cloud-trace/samples/snippets/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -google-cloud-trace==1.11.0 \ No newline at end of file