forked from googleapis/python-datastore
-
Notifications
You must be signed in to change notification settings - Fork 0
/
synth.py
139 lines (114 loc) · 4.04 KB
/
synth.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
# 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
gapic = gcp.GAPICBazel()
common = gcp.CommonTemplates()
# ----------------------------------------------------------------------------
# Generate datastore GAPIC layer
# ----------------------------------------------------------------------------
library = gapic.py_library(
service="datastore",
version="v1",
bazel_target="//google/datastore/v1:datastore-v1-py",
include_protos=True,
)
s.move(library / "google/cloud/datastore_v1")
s.move(
library / f"tests/",
f"tests",
)
s.move(library / "scripts")
# ----------------------------------------------------------------------------
# Generate datastore admin GAPIC layer
# ----------------------------------------------------------------------------
library = gapic.py_library(
service="datastore_admin",
version="v1",
bazel_target="//google/datastore/admin/v1:datastore-admin-v1-py",
include_protos=True,
)
s.move(
library / "google/cloud/datastore_admin_v1",
"google/cloud/datastore_admin_v1"
)
s.move(
library / f"tests/",
f"tests",
)
s.move(library / "scripts")
s.replace(
"google/**/datastore_admin_client.py",
"google-cloud-datastore-admin",
"google-cloud-datstore"
)
# Remove spurious markup
s.replace(
"google/**/datastore_admin/client.py",
"\s+---------------------------------(-)+",
""
)
# ----------------------------------------------------------------------------
# Add templated files
# ----------------------------------------------------------------------------
# TODO: cov_level should be 99%, reduced due to regression in test coverage.
templated_files = common.py_library(
unit_cov_level=97,
cov_level=97,
unit_test_python_versions=["3.6", "3.7", "3.8"],
system_test_python_versions=["3.8"],
)
s.move(templated_files, excludes=["docs/multiprocessing.rst", ".coveragerc"])
s.replace("noxfile.py", """["']sphinx['"]""", '''"sphinx<3.0.0"''')
# Add the `sphinx-ext-doctest` extenaion
s.replace(
"docs/conf.py",
"""\
"sphinx.ext.coverage",
"sphinx.ext.napoleon",
""",
"""\
"sphinx.ext.coverage",
"sphinx.ext.doctest",
"sphinx.ext.napoleon",
""",
)
s.shell.run(["nox", "-s", "blacken"], hide_output=False)
# Add documentation about creating indexes and populating data for system
# tests.
num = s.replace(
"CONTRIBUTING.rst",
'app_credentials.json"',
"""app_credentials.json"
- 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""")
if num != 1:
raise Exception("Required replacement not made.")