Repository navigation
Expand file tree
/
Copy pathowlbot.py
More file actions
320 lines (280 loc) · 11.8 KB
/
Copy pathowlbot.py
File metadata and controls
320 lines (280 loc) · 11.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
# Copyright 2018 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT 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."""
from pathlib import Path
import re
import textwrap
from typing import List, Optional
import synthtool as s
from synthtool import gcp, _tracked_paths
from synthtool.languages import python
from synthtool.sources import templates
common = gcp.CommonTemplates()
# This is a customized version of the s.get_staging_dirs() function from synthtool to
# cater for copying 2 different folders from googleapis-gen
# which are bigtable and bigtable/admin.
# Source https://github.com/googleapis/synthtool/blob/master/synthtool/transforms.py#L280
def get_staging_dirs(
default_version: Optional[str] = None, sub_directory: Optional[str] = None
) -> List[Path]:
"""Returns the list of directories, one per version, copied from
https://github.com/googleapis/googleapis-gen. Will return in lexical sorting
order with the exception of the default_version which will be last (if specified).
Args:
default_version (str): the default version of the API. The directory for this version
will be the last item in the returned list if specified.
sub_directory (str): if a `sub_directory` is provided, only the directories within the
specified `sub_directory` will be returned.
Returns: the empty list if no file were copied.
"""
staging = Path("owl-bot-staging")
if sub_directory:
staging /= sub_directory
if staging.is_dir():
# Collect the subdirectories of the staging directory.
versions = [v.name for v in staging.iterdir() if v.is_dir()]
# Reorder the versions so the default version always comes last.
versions = [v for v in versions if v != default_version]
versions.sort()
if default_version is not None:
versions += [default_version]
dirs = [staging / v for v in versions]
for dir in dirs:
s._tracked_paths.add(dir)
return dirs
else:
return []
# This library ships clients for two different APIs,
# BigTable and BigTable Admin
bigtable_default_version = "v2"
bigtable_admin_default_version = "v2"
# These flags are needed because certain post-processing operations
# append things after a certain line of text, and can infinitely loop
# in a Github PR. We use these flags to only do those operations
# on fresh copies of files found in googleapis-gen, and not on user-submitted
# changes.
is_fresh_admin_copy = False
is_fresh_admin_v2_copy = False
is_fresh_admin_docs_copy = False
for library in get_staging_dirs(bigtable_default_version, "bigtable"):
s.move(library / "google/cloud/bigtable_v2", excludes=["**/gapic_version.py"])
s.move(library / "tests")
s.move(library / "scripts")
for library in get_staging_dirs(bigtable_admin_default_version, "bigtable_admin"):
is_fresh_admin_copy = \
s.move(library / "google/cloud/bigtable_admin", excludes=["**/gapic_version.py"])
is_fresh_admin_v2_copy = \
s.move(library / "google/cloud/bigtable_admin_v2", excludes=["**/gapic_version.py"])
s.move(library / "tests")
s.move(library / "samples")
s.move(library / "scripts")
is_fresh_admin_docs_copy = \
s.move(library / "docs/bigtable_admin_v2", destination="docs/admin_client")
s.remove_staging_dirs()
# ----------------------------------------------------------------------------
# Add templated files
# ----------------------------------------------------------------------------
templated_files = common.py_library(
samples=True, # set to True only if there are samples
split_system_tests=True,
microgenerator=True,
cov_level=99,
system_test_external_dependencies=[
"pytest-asyncio==0.21.2",
],
)
s.move(templated_files, excludes=[".coveragerc", "README.rst", ".github/release-please.yml", "noxfile.py", "renovate.json"])
# ----------------------------------------------------------------------------
# Always supply app_profile_id in routing headers: https://github.com/googleapis/python-bigtable/pull/1109
# TODO: remove after backend no longer requires empty strings
# ----------------------------------------------------------------------------
for file in ["async_client.py", "client.py"]:
s.replace(
f"google/cloud/bigtable_v2/services/bigtable/{file}",
"if request.app_profile_id:",
"if True: # always attach app_profile_id, even if empty string"
)
# fix tests
s.replace(
"tests/unit/gapic/bigtable_v2/test_bigtable.py",
'assert \(\n\s*gapic_v1\.routing_header\.to_grpc_metadata\(expected_headers\) in kw\["metadata"\]\n.*',
"""
# assert the expected headers are present, in any order
routing_string = next(iter([m[1] for m in kw["metadata"] if m[0] == 'x-goog-request-params']))
assert all([f"{k}={v}" in routing_string for k,v in expected_headers.items()])
"""
)
s.replace(
"tests/unit/gapic/bigtable_v2/test_bigtable.py",
'expected_headers = {"name": "projects/sample1/instances/sample2"}',
'expected_headers = {"name": "projects/sample1/instances/sample2", "app_profile_id": ""}'
)
s.replace(
"tests/unit/gapic/bigtable_v2/test_bigtable.py",
"""
expected_headers = {
"table_name": "projects/sample1/instances/sample2/tables/sample3"
}
""",
"""
expected_headers = {
"table_name": "projects/sample1/instances/sample2/tables/sample3",
"app_profile_id": ""
}
"""
)
# ----------------------------------------------------------------------------
# Samples templates
# ----------------------------------------------------------------------------
python.py_samples(skip_readmes=True)
s.replace(
"samples/beam/noxfile.py",
"""INSTALL_LIBRARY_FROM_SOURCE \= os.environ.get\("INSTALL_LIBRARY_FROM_SOURCE", False\) in \(
"True",
"true",
\)""",
"""# todo(kolea2): temporary workaround to install pinned dep version
INSTALL_LIBRARY_FROM_SOURCE = False""")
# --------------------------------------------------------------------------
# Admin Overlay work
# --------------------------------------------------------------------------
# Add overlay imports to top level __init__.py files in admin_v2 and admin at the end
# of each file, after the __all__ definition. These changes should only be done on fresh
# copies of the __init__.py files.
def add_overlay_to_init_py(init_py_location, import_statements, should_add):
if should_add:
s.replace(
init_py_location,
r"(?s)(^__all__ = \(.*\)$)",
r"\1\n\n" + import_statements
)
add_overlay_to_init_py(
"google/cloud/bigtable_admin_v2/__init__.py",
"""from .overlay import * # noqa: F403
__all__ += overlay.__all__ # noqa: F405
""",
is_fresh_admin_v2_copy,
)
add_overlay_to_init_py(
"google/cloud/bigtable_admin/__init__.py",
"""import google.cloud.bigtable_admin_v2.overlay # noqa: F401
from google.cloud.bigtable_admin_v2.overlay import * # noqa: F401, F403
__all__ += google.cloud.bigtable_admin_v2.overlay.__all__
""",
is_fresh_admin_copy,
)
# Replace all instances of BaseBigtableTableAdminClient/BaseBigtableAdminAsyncClient
# in samples and docstrings with BigtableTableAdminClient/BigtableTableAdminAsyncClient
s.replace(
[
"google/cloud/bigtable_admin_v2/services/*/client.py",
"google/cloud/bigtable_admin_v2/services/*/async_client.py",
"samples/generated_samples/bigtableadmin_v2_*.py"
],
r"client = bigtable_admin_v2\.Base(BigtableTableAdmin(Async)?Client\(\))",
r"client = bigtable_admin_v2.\1"
)
# Fix an improperly formatted table that breaks nox -s docs.
s.replace(
"google/cloud/bigtable_admin_v2/types/table.py",
""" For example, if \\\\_key =
"some_id#2024-04-30#\\\\x00\\\\x13\\\\x00\\\\xf3" with the following
schema: \\{ fields \\{ field_name: "id" type \\{ string \\{
encoding: utf8_bytes \\{\\} \\} \\} \\} fields \\{ field_name: "date"
type \\{ string \\{ encoding: utf8_bytes \\{\\} \\} \\} \\} fields \\{
field_name: "product_code" type \\{ int64 \\{ encoding:
big_endian_bytes \\{\\} \\} \\} \\} encoding \\{ delimited_bytes \\{
delimiter: "#" \\} \\} \\}
\\| The decoded key parts would be: id = "some_id", date =
"2024-04-30", product_code = 1245427 The query "SELECT
\\\\_key, product_code FROM table" will return two columns:
/------------------------------------------------------
\\| \\\\\\| \\\\_key \\\\\\| product_code \\\\\\| \\\\\\|
--------------------------------------\\|--------------\\\\\\| \\\\\\|
"some_id#2024-04-30#\\\\x00\\\\x13\\\\x00\\\\xf3" \\\\\\| 1245427 \\\\\\|
------------------------------------------------------/
""",
textwrap.indent(
"""For example, if \\\\_key =
"some_id#2024-04-30#\\\\x00\\\\x13\\\\x00\\\\xf3" with the following
schema:
.. code-block::
{
fields {
field_name: "id"
type { string { encoding: utf8_bytes {} } }
}
fields {
field_name: "date"
type { string { encoding: utf8_bytes {} } }
}
fields {
field_name: "product_code"
type { int64 { encoding: big_endian_bytes {} } }
}
encoding { delimited_bytes { delimiter: "#" } }
}
The decoded key parts would be:
id = "some_id", date = "2024-04-30", product_code = 1245427
The query "SELECT \\\\_key, product_code FROM table" will return
two columns:
+========================================+==============+
| \\\\_key | product_code |
+========================================+==============+
| "some_id#2024-04-30#\\\\x00\\\\x13\\\\x00\\\\xf3" | 1245427 |
+----------------------------------------+--------------+
""",
" " * 12,
),
)
# These changes should only be done on fresh copies of the .rst files
# from googleapis-gen.
if is_fresh_admin_docs_copy:
# Change the subpackage for clients with overridden internal methods in them
# from service to overlay.service.
s.replace(
"docs/admin_client/bigtable_table_admin.rst",
r"^\.\. automodule:: google\.cloud\.bigtable_admin_v2\.services\.bigtable_table_admin$",
".. automodule:: google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin"
)
# Add overlay types to types documentation
s.replace(
"docs/admin_client/types_.rst",
r"""(\.\. automodule:: google\.cloud\.bigtable_admin_v2\.types
:members:
:show-inheritance:)
""",
r"""\1
.. automodule:: google.cloud.bigtable_admin_v2.overlay.types
:members:
:show-inheritance:
"""
)
# These changes should only be done on a fresh copy of table.py
# from googleapis-gen.
if is_fresh_admin_v2_copy:
# Add the oneof_message import into table.py for GcRule
s.replace(
"google/cloud/bigtable_admin_v2/types/table.py",
r"^(from google\.cloud\.bigtable_admin_v2\.types import .+)$",
r"""\1
from google.cloud.bigtable_admin_v2.utils import oneof_message""",
)
# Re-subclass GcRule in table.py
s.replace(
"google/cloud/bigtable_admin_v2/types/table.py",
r"class GcRule\(proto\.Message\)\:",
"class GcRule(oneof_message.OneofMessage):",
)
s.shell.run(["nox", "-s", "blacken"], hide_output=False)