/
owlbot.py
203 lines (172 loc) · 5.35 KB
/
owlbot.py
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
# 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."""
import synthtool as s
from synthtool import gcp
from synthtool.languages import python
common = gcp.CommonTemplates()
# This library ships clients for two different APIs,
# Datastore and Datastore Admin
datastore_default_version = "v1"
datastore_admin_default_version = "v1"
for library in s.get_staging_dirs(datastore_default_version):
if library.parent.absolute() == "datastore":
s.move(library / f"google/cloud/datastore_{library.name}")
s.move(library / "tests/")
s.move(library / "scripts")
for library in s.get_staging_dirs(datastore_admin_default_version):
if library.parent.absolute() == "datastore_admin":
s.replace(
library / "google/**/datastore_admin_client.py",
"google-cloud-datastore-admin",
"google-cloud-datstore",
)
# Remove spurious markup
s.replace(
"google/**/datastore_admin/client.py",
r"\s+---------------------------------(-)+",
"",
)
s.move(library / f"google/cloud/datastore_admin_{library.name}")
s.move(library / "tests")
s.move(library / "scripts")
s.remove_staging_dirs()
# ----------------------------------------------------------------------------
# Add templated files
# ----------------------------------------------------------------------------
templated_files = common.py_library(
microgenerator=True,
split_system_tests=True,
unit_test_python_versions=["3.6", "3.7", "3.8", "3.9", "3.10"],
)
s.move(
templated_files,
excludes=["docs/multiprocessing.rst", ".coveragerc", ".github/CODEOOWNERS"],
)
python.py_samples(skip_readmes=True)
# Preserve system tests w/ GOOGLE_DISABLE_GRPC set (#133, PR #136)
assert 1 == s.replace(
"noxfile.py",
r"""\
@nox.session\(python=SYSTEM_TEST_PYTHON_VERSIONS\)
def system\(session\):
""",
"""\
@nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS)
@nox.parametrize("disable_grpc", [False, True])
def system(session, disable_grpc):
""",
)
assert 1 == s.replace(
"noxfile.py",
"""\
# Run py.test against the system tests.
""",
"""\
env = {}
if disable_grpc:
env["GOOGLE_CLOUD_DISABLE_GRPC"] = "True"
# Run py.test against the system tests.
""",
)
assert 1 == s.replace(
"noxfile.py",
"""\
system_test_path,
""",
"""\
system_test_path,
env=env,
""",
)
assert 1 == s.replace(
"noxfile.py",
"""\
system_test_folder_path,
""",
"""\
system_test_folder_path,
env=env,
""",
)
# Add nox session to exercise doctests
assert 1 == s.replace(
"noxfile.py",
r"""\
"blacken",
"docs",
""",
"""\
"blacken",
"docs",
"doctests",
""",
)
assert 1 == s.replace(
"noxfile.py",
r"""\
@nox.session\(python=DEFAULT_PYTHON_VERSION\)
def docfx\(session\):
""",
"""\
@nox.session(python="3.6")
def doctests(session):
# Doctests run against Python 3.6 only.
# It is difficult to make doctests run against both Python 2 and Python 3
# because they test string output equivalence, which is difficult to
# make match (e.g. unicode literals starting with "u").
# Install all test dependencies, then install this package into the
# virtualenv's dist-packages.
session.install("mock", "pytest", "sphinx", "google-cloud-testutils")
session.install("-e", ".")
# Run py.test against the system tests.
session.run("py.test", "tests/doctests.py")
@nox.session(python=DEFAULT_PYTHON_VERSION)
def docfx(session):
""",
)
# Add documentation about creating indexes and populating data for system
# tests.
assert 1 == s.replace(
"CONTRIBUTING.rst",
r"""
\*\*\*\*\*\*\*\*\*\*\*\*\*
Test Coverage
\*\*\*\*\*\*\*\*\*\*\*\*\*
""",
"""
- You'll need to create composite
`indexes <https://cloud.google.com/datastore/docs/tools/indexconfig>`__
with the ``gcloud`` command line
`tool <https://developers.google.com/cloud/sdk/gcloud/>`__::
# Install the app (App Engine Command Line Interface) component.
$ gcloud components install app-engine-python
# Authenticate the gcloud tool with your account.
$ GOOGLE_APPLICATION_CREDENTIALS="path/to/app_credentials.json"
$ gcloud auth activate-service-account \
> --key-file=${GOOGLE_APPLICATION_CREDENTIALS}
# Create the indexes
$ gcloud datastore indexes create tests/system/index.yaml
- You'll also need stored data in your dataset. To populate this data, run::
$ python tests/system/utils/populate_datastore.py
- If you make a mistake during development (i.e. a failing test that
prevents clean-up) you can clear all system test data from your
datastore instance via::
$ python tests/system/utils/clear_datastore.py
*************
Test Coverage
*************
""",
)
s.shell.run(["nox", "-s", "blacken"], hide_output=False)